docs: Reference rust doc style guide in contributing guidelines #2452
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
It is good for us to follow the common rust documentation style guide, so explicitly reference this guide.
dignifiedquire
approved these changes
Jul 3, 2024
Frando
reviewed
Jul 3, 2024
Co-authored-by: Franz Heinzmann <[email protected]>
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
matheus23
pushed a commit
that referenced
this pull request
Nov 14, 2024
## Description It is good for us to follow the common rust documentation style guide, so explicitly reference this guide. ## Breaking Changes <!-- Optional, if there are any breaking changes document them, including how to migrate older code. --> ## Notes & open questions I'm effectively introducing a new policy here. Feel free to discuss. ## Change checklist - [x] Self-review. - [x] Documentation updates if relevant. - ~~[ ] Tests if relevant.~~ - ~~[ ] All breaking changes documented.~~ --------- Co-authored-by: Franz Heinzmann <[email protected]>
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.
Description
It is good for us to follow the common rust documentation style guide,
so explicitly reference this guide.
Breaking Changes
Notes & open questions
I'm effectively introducing a new policy here. Feel free to discuss.
Change checklist
[ ] Tests if relevant.[ ] All breaking changes documented.