docs: remove em dashes from docstrings - #39
Merged
Conversation
Reword every docstring em-dash (semicolon, colon, or comma as each sentence needs). The generated API reference in the docs site derives from these docstrings, and the docs style bans em-dashes; this was the only remaining source of them. Code comments are untouched (they never reach the reference).
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
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.
The docs site bans em-dashes in prose, and its generated SDK API reference was the last place they appeared. They came from these docstrings.
Every docstring em-dash is reworded with the punctuation each sentence needs (semicolon, colon, or comma); no semantic changes. Code comments keep theirs, since they never reach the generated reference.
Lands in the published reference with the next release + docs pin bump (argus-docs auto-bump workflow).