Summary
Move the maxPages constant and its documentation above the getList doc comment in internal/api/client.go.
Rationale
The current declaration is positioned between the getList documentation and the function. As a result, Go documentation associates the trailing paragraph with maxPages, while getList no longer has a correctly attached doc comment.
Affected area
internal/api/client.go
maxPages(*Client).getList
Required change
Reorder the declarations so that:
maxPages is immediately preceded by its own // maxPages ... comment.- The
// getList ... comment immediately precedes func (c *Client) getList(...).
Acceptance criteria
maxPages and getList each have a correctly attached Go doc comment.- The change is documentation/declaration ordering only; pagination behaviour remains unchanged.
Backlinks
Summary
Move the
maxPagesconstant and its documentation above thegetListdoc comment ininternal/api/client.go.Rationale
The current declaration is positioned between the
getListdocumentation and the function. As a result, Go documentation associates the trailing paragraph withmaxPages, whilegetListno longer has a correctly attached doc comment.Affected area
internal/api/client.gomaxPages(*Client).getListRequired change
Reorder the declarations so that:
maxPagesis immediately preceded by its own// maxPages ...comment.// getList ...comment immediately precedesfunc (c *Client) getList(...).Acceptance criteria
maxPagesandgetListeach have a correctly attached Go doc comment.Backlinks