Repository navigation
Revise wording in the documentation and help text - #60
Merged
Merged
Conversation
glopesdev
force-pushed
the
docs-wording
branch
from
November 2, 2026 22:02
b7cb531 to
2aee329
Compare
The generate, update and verify articles and the README are reworded to use plainer sentences, and the documentation and help text are consistent across commands. Each verify item is now called a test in the help, the output and the article.
glopesdev
force-pushed
the
docs-wording
branch
from
November 2, 2026 22:50
2aee329 to
e5c0107
Compare
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
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.
The generate, update and verify articles and the README are reworded to use plainer sentences. The documentation and command help text are made consistent across commands: the generate article gains an Exit code section like the update and verify articles, value descriptions drop the leading article, backticks that the terminal printed literally are removed, and the
csharpandgenerate metadatadescriptions follow the style of their siblings.Each
verifyitem is now called a test in the help, the output and the article, matching the code and the report.