This repository was archived by the owner on Jan 30, 2026. It is now read-only.
docs: explicitly avoid trailing periods for verbatim doc comments#185
Merged
docs: explicitly avoid trailing periods for verbatim doc comments#185
Conversation
Greptile SummaryRemoved trailing periods from doc comments on CLI commands that use the
Confidence Score: 5/5
Important Files Changed
Sequence DiagramsequenceDiagram
participant Dev as Developer
participant CLI as CLI Source
participant Clap as Clap Parser
participant User as End User
Dev->>CLI: Remove trailing periods from doc comments
Note over Dev,CLI: Update comments for Config,<br/>GetAccountMetrics,<br/>GetBasinMetrics,<br/>GetStreamMetrics
Dev->>CLI: Update logo assets
Note over Dev,CLI: Replace s2-black.png<br/>and s2-white.png
CLI->>Clap: Parse with verbatim_doc_comment
Note over Clap: Doc comments preserved<br/>exactly as written<br/>(no trailing periods)
Clap->>User: Display help text
Note over User: Help text shows commands<br/>without trailing periods
|
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.