Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Many methods/functions are missing go doc information #4

Open
nemith opened this issue Apr 9, 2019 · 1 comment
Open

Many methods/functions are missing go doc information #4

nemith opened this issue Apr 9, 2019 · 1 comment
Labels
easy Good for newcomers enhancement New feature or request
Milestone

Comments

@nemith
Copy link

nemith commented Apr 9, 2019

A lot of the standard methods are missing go doc. We should align the documentation with that found from the Java client lib (https://zookeeper.apache.org/doc/r3.4.14/api/index.html)

conn.go:57:6: exported type Dialer should have comment or be unexported
conn.go:69:6: exported type Conn should have comment or be unexported
conn.go:140:6: exported type Event should have comment or be unexported
conn.go:313:1: exported method Conn.Close should have comment or be unexported
conn.go:987:1: exported method Conn.AddAuth should have comment or be unexported
conn.go:1013:1: exported method Conn.Children should have comment or be unexported
conn.go:1026:1: exported method Conn.ChildrenW should have comment or be unexported
conn.go:1044:1: exported method Conn.Get should have comment or be unexported
conn.go:1076:1: exported method Conn.Set should have comment or be unexported
conn.go:1089:1: exported method Conn.Create should have comment or be unexported
conn.go:1151:1: exported method Conn.Delete should have comment or be unexported
conn.go:1160:1: exported method Conn.Exists should have comment or be unexported
conn.go:1178:1: exported method Conn.ExistsW should have comment or be unexported
conn.go:1203:1: exported method Conn.GetACL should have comment or be unexported
conn.go:1215:1: exported method Conn.SetACL should have comment or be unexported
conn.go:1228:1: exported method Conn.Sync should have comment or be unexported
conn.go:1241:6: exported type MultiResponse should have comment or be unexported
constants.go:10:2: exported const DefaultPort should have comment (or a comment on this block) or be unexported
constants.go:37:2: exported const EventNodeCreated should have comment (or a comment on this block) or be unexported
constants.go:58:2: exported const StateUnknown should have comment (or a comment on this block) or be unexported
constants.go:71:2: exported const FlagEphemeral should have comment (or a comment on this block) or be unexported
constants.go:89:6: exported type State should have comment or be unexported
constants.go:98:6: exported type ErrCode should have comment or be unexported
constants.go:101:2: exported var ErrConnectionClosed should have comment or be unexported
constants.go:208:6: exported type EventType should have comment or be unexported
constants.go:228:2: exported const ModeUnknown should have comment (or a comment on this block) or be unexported
server_help.go:18:6: exported type TestServer should have comment or be unexported
server_help.go:24:6: exported type TestCluster should have comment or be unexported
server_help.go:29:1: exported function StartTestCluster should have comment or be unexported
server_help.go:102:1: exported method TestCluster.Connect should have comment or be unexported
server_help.go:107:1: exported method TestCluster.ConnectAll should have comment or be unexported
server_help.go:111:1: exported method TestCluster.ConnectAllTimeout should have comment or be unexported
server_help.go:115:1: exported method TestCluster.ConnectWithOptions should have comment or be unexported
server_help.go:124:1: exported method TestCluster.Stop should have comment or be unexported
server_help.go:176:1: exported method TestCluster.StartServer should have comment or be unexported
server_help.go:186:1: exported method TestCluster.StopServer should have comment or be unexported
server_help.go:196:1: exported method TestCluster.StartAllServers should have comment or be unexported
server_help.go:207:1: exported method TestCluster.StopAllServers should have comment or be unexported
server_java.go:11:6: exported type ErrMissingServerConfigField should have comment or be unexported
server_java.go:18:2: exported const DefaultServerTickTime should have comment (or a comment on this block) or be unexported
server_java.go:26:6: exported type ServerConfigServer should have comment or be unexported
server_java.go:33:6: exported type ServerConfig should have comment or be unexported
server_java.go:44:1: exported method ServerConfig.Marshall should have comment or be unexported
server_java.go:113:6: exported type Server should have comment or be unexported
server_java.go:121:1: exported method Server.Start should have comment or be unexported
server_java.go:134:1: exported method Server.Stop should have comment or be unexported
structs.go:13:2: exported var ErrUnhandledFieldType should have comment or be unexported
structs.go:24:6: exported type ACL should have comment or be unexported
structs.go:30:6: exported type Stat should have comment or be unexported
structs.go:121:6: exported type PathVersionRequest should have comment or be unexported
structs.go:141:6: exported type CheckVersionRequest should have comment or be unexported
structs.go:160:6: exported type CreateRequest should have comment or be unexported
structs.go:168:6: exported type DeleteRequest should have comment or be unexported
structs.go:225:6: exported type SetDataRequest should have comment or be unexported
util.go:27:1: exported function DigestACL should have comment or be unexported
@nemith nemith added enhancement New feature or request easy Good for newcomers labels Apr 9, 2019
@nemith nemith added this to the v1.1.0 milestone Apr 9, 2019
@linsite
Copy link

linsite commented Jun 20, 2021

I'd like to help with it, but I can't find the comment in java at the specific page, would you point it out?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
easy Good for newcomers enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants