Conversation
Signed-off-by: Johannes Großmann <grossmann.johannes@t-online.de>
![docker-agent[bot]](https://avatars.githubusercontent.com/in/2787757?s=60&v=4){kind=small}
There was a problem hiding this comment.
Assessment: 🟢 APPROVE
This PR replaces # shell-comment markers with ### Markdown heading markers in Cobra Example strings. No logic, security, or functional issues are introduced. Two minor style observations are noted inline — Cobra renders Example fields verbatim in the terminal, so ### will appear literally rather than as rendered headings.
| Short: "Remove secrets from local keychain.", | ||
| Long: "Removes one or more named secrets from the local OS keychain.\nUse --all to remove every stored secret at once.", | ||
| Example: `# Remove a specific secret: | ||
| Example: `### Remove a specific secret: |
There was a problem hiding this comment.
LOW: Example section headers use ### (Markdown heading) instead of conventional # (shell comment)
Cobra does not render Markdown — the Example field is printed verbatim to the terminal. Replacing # Remove a specific secret: with ### Remove a specific secret: means users will see raw ### syntax in docker pass rm --help output.
The # prefix is both standard shell comment syntax and the de-facto Cobra/Docker CLI convention (used by Docker CLI, kubectl, and most Cobra-based tools). Consider reverting to # for consistent terminal UX.
|
|
||
| const setExample = ` | ||
| # Set a secret: | ||
| ### Set a secret: |
There was a problem hiding this comment.
LOW: Example section headers use ### (Markdown heading) instead of conventional # (shell comment)
Same issue as rm.go: replacing # Set a secret: with ### Set a secret: causes docker pass set --help to display raw Markdown heading syntax in the terminal. Cobra prints Example strings as-is with no Markdown processing, so ### appears literally to users and deviates from the shell-comment convention.
Consider reverting to # for consistency with Docker CLI and Cobra ecosystem conventions.
2 participants
No description provided.