doc: streamline Error and Argument sections #1603
Open
Conversation
This file contains 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
Streamline all `# Errors` and `# Arguments` sections. This is about the style, not the content. The advantage of this streamlined and consistent style, is that new contributions can follow the guideline. This however is only a partial solution, in case we ever want to have a 100% streamlined documentation across the whole crate. No major changes have been made with a few small exceptions, where I deleted obviously wrong or irrelevant error codes.
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.
Streamline all
# Errorsand# Argumentssections. This is aboutthe style, not the content. The advantage of this streamlined and
consistent style, is that new contributions can follow the guideline.
This however is only a partial solution, in case we ever want to have a
100% streamlined documentation across the whole crate.
No major changes have been made with a few small exceptions, where I
deleted obviously wrong or irrelevant error codes.
Checklist