Skip to content

docs: add Go doc comments for exported functions (golint/godoc)#2493

Open
AdaAibaby wants to merge 2 commits intoe2b-dev:mainfrom
AdaAibaby:chore/docs-add-auth-comments
Open

docs: add Go doc comments for exported functions (golint/godoc)#2493
AdaAibaby wants to merge 2 commits intoe2b-dev:mainfrom
AdaAibaby:chore/docs-add-auth-comments

Conversation

@AdaAibaby
Copy link
Copy Markdown

@AdaAibaby AdaAibaby commented Apr 24, 2026

  • Motivation:
    Ensure exported Go symbols follow godoc/golint conventions so generated docs are complete and linters stop flagging missing comments.
  • Scope:
    Add doc comments for exported functions, types and constants in auth.go files (e.g., GetTeam, AccessTokenData, AuthCache, signing constants); fix misplaced comments and run gofmt.
  • Impact:
    Documentation/formatting only — no runtime behavior changes. Improves generated API docs and reduces linter noise.

Copy link
Copy Markdown

@claude claude Bot left a comment

Choose a reason for hiding this comment

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

Claude Code Review

This pull request is from a fork — automated review is disabled. A repository maintainer can comment @claude review to run a one-time review.

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 521b1df069

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment thread packages/docker-reverse-proxy/internal/cache/auth.go Outdated
Move comments for AccessTokenData and AuthCache structs.
@ValentaTomas ValentaTomas removed their assignment May 1, 2026
@ValentaTomas ValentaTomas removed their request for review May 1, 2026 19:54
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.

3 participants