Skip to content

Add documentation to client.go and instance.go public methods#280

Open
naikmubashir wants to merge 3 commits into
civo:masterfrom
naikmubashir:master
Open

Add documentation to client.go and instance.go public methods#280
naikmubashir wants to merge 3 commits into
civo:masterfrom
naikmubashir:master

Conversation

@naikmubashir

Copy link
Copy Markdown

📚 Documentation Enhancement

Addresses issue #279 by adding comprehensive Go documentation to all public methods in client.go and instance.go.

Key Changes:

  • Fixed UpdateInstanceBandwidth documentation (was incorrect)
  • Added documentation to 9 methods in client.go
  • Added documentation to 25 methods in instance.go

Standards Applied:

  • Clear purpose descriptions
  • Parameter and return value documentation
  • Error condition explanations
  • Usage warnings for destructive operations

All documentation follows Go conventions and significantly improves API usability.

Closes #279

Signed-off-by: Naik Mubashir <naikmubashir095@gmail.com>
Signed-off-by: Naik Mubashir <naikmubashir095@gmail.com>
@giornetta

Copy link
Copy Markdown
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 giornetta left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Incomplete Documentation for Public Methods

2 participants