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

doc: gorums.NewServer claims to be for internal use #172

Open
meling opened this issue Feb 4, 2024 · 0 comments
Open

doc: gorums.NewServer claims to be for internal use #172

meling opened this issue Feb 4, 2024 · 0 comments
Labels
doc Documentation

Comments

@meling
Copy link
Member

meling commented Feb 4, 2024

The documentation in server.go claims:

// NewServer returns a new instance of GorumsServer.
// This function is intended for internal Gorums use.
// You should call `NewServer` in the generated code instead.
func NewServer(opts ...ServerOption) *Server {

However, this function is not called by generated code but only by users. There is no NewServer in the generated code. We should remove the incorrect description.

@meling meling added the doc Documentation label Feb 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation
Projects
None yet
Development

No branches or pull requests

1 participant