Fix Go doc-comment association for maxPages and getList
@khvn26 is already working on this.
Since Jul 28, 2026.
Assessment
This issue has not been assessed yet.
Description
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.gomaxPages(*Client).getList
Required change
Reorder the declarations so that:
maxPagesis immediately preceded by its own// maxPages ...comment.- The
// getList ...comment immediately precedesfunc (c *Client) getList(...).
Acceptance criteria
maxPagesandgetListeach have a correctly attached Go doc comment.- The change is documentation/declaration ordering only; pagination behaviour remains unchanged.
Backlinks
- Deferred from PR #43: https://github.com/Flagsmith/flagsmith-cli/pull/43
- Review comment: https://github.com/Flagsmith/flagsmith-cli/pull/43#discussion_r3666673361
- Requested by: @khvn26
- Dominant language
- Go
- Stars
- 12
- Forks
- 3
- Avg merge
- 14h 56m
- Merged PRs (30d)
- 8
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Flagsmith/flagsmith-cli
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Flagsmith/flagsmith-cli#64 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 68/100
Flagsmith/flagsmith-cli#107 ·
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
Flagsmith/flagsmith-cli#95 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
Flagsmith/flagsmith-cli#93 ·
-
Dependency Dashboard Open
Difficulty 2/5 1-3 hours Newbie friendliness 25/100
Flagsmith/flagsmith-cli#90 ·
All issues in Flagsmith/flagsmith-cli
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 84/100
-
enhancement needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
kind/cleanup
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
kubernetes-sigs/kueue#15947 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
sympozium-ai/sympozium#627 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100