fill todo doc comments in zingo-cli#2303
Open
evanbranigan-dotcom wants to merge 1 commit intozingolabs:devfrom
Open
fill todo doc comments in zingo-cli#2303evanbranigan-dotcom wants to merge 1 commit intozingolabs:devfrom
evanbranigan-dotcom wants to merge 1 commit intozingolabs:devfrom
Conversation
Add doc comments for all TODO placeholders across zingo-cli/src: - lib.rs: crate-level docs, command_loop(), ConfigTemplate - commands.rs: module docs, short_help(), ShortCircuitedCommand, HelpCommand, get_commands(), do_user_command() - version.rs: module and VERSION const docs Note: commands.rs line 1-2 originally read "An interface that passes strings (e.g. from a cli, into zingolib) / upgrade-or-replace" — replaced with clearer module docs. The "upgrade-or-replace" note may have been intentional; happy to restore if needed. AI disclosure: doc comments drafted with Claude Code (Anthropic), reviewed and verified against source by human contributor. Fixes: zingolabs#2301
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Fixes: #2301
Retargeted against
devper @zancas feedback on #2301.Fill all TODO placeholder doc comments across
zingo-cli/src/:command_loop(),ConfigTemplateshort_help(),ShortCircuitedCommand,HelpCommand,get_commands(),do_user_command()VERSIONconst docsNote:
commands.rsline 1-2 originally read "An interface that passes strings (e.g. from a cli, into zingolib) / upgrade-or-replace" — replaced with clearer module docs. The "upgrade-or-replace" note may have been intentional @zancas; happy to restore if needed.AI disclosure: Doc comments drafted with Claude Code (Anthropic), reviewed and verified against source by human contributor.