Flagsmith / Flagsmith/flagsmith-cli

Fix Go doc-comment association for maxPages and getList

未关闭
#49 0 条评论 0 个 reaction 已指派 1 人 已被 @khvn26 认领 在 GitHub 查看
主要语言
Go
星标
12
派生
3
平均合并
14 小时 56 分钟
30 天内合并 PR
8

描述

## 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:
1. `maxPages` is immediately preceded by its own `// maxPages ...` comment.
2. 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

- 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

贡献指南

这个仓库没有索引到贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。