Add documentation to client.go and instance.go public methods#280
Open
naikmubashir wants to merge 3 commits into
Open
Add documentation to client.go and instance.go public methods#280naikmubashir wants to merge 3 commits into
naikmubashir wants to merge 3 commits into
Conversation
Signed-off-by: Naik Mubashir <naikmubashir095@gmail.com>
Signed-off-by: Naik Mubashir <naikmubashir095@gmail.com>
Member
|
Hi @naikmubashir thank you for this and sorry for the delay! I'll look into this as soon as I have a minute! |
giornetta
reviewed
Nov 10, 2025
giornetta
left a comment
Member
There was a problem hiding this comment.
I don't think this documentation style is great: it's very verbose and the parameters/returns descriptions are often unnecessary, and their names and types should be self documenting in my opinion.
There are cases where a more detailed description for parameters might be necessary, for example to explain func NewClientForTesting(responses map[string]string) (*Client, *httptest.Server, error), so I would keep the details only in these cases
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
📚 Documentation Enhancement
Addresses issue #279 by adding comprehensive Go documentation to all public methods in
client.goandinstance.go.Key Changes:
UpdateInstanceBandwidthdocumentation (was incorrect)client.goinstance.goStandards Applied:
All documentation follows Go conventions and significantly improves API usability.
Closes #279