This repository has been archived by the owner on Jan 29, 2025. It is now read-only.
Standardize some docs #1660
Merged
Standardize some docs #1660
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
|
Thank you! Looks like Rustfmt isn't happy about some of the lines? |
kvark
reviewed
Jan 11, 2022
|
Please rebase and make CI happy |
- Use line comments instead of block comments - Standardize language for each front/backend - Add reference link for each format - Minor punctuation changes
NoelTautges
force-pushed
the
docs-work
branch
from
edd67c3 to
515595d
Compare
|
Finally got around to this! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This pull request standardizes some list items, links some references, fills in some missing docs, corrects capitalization, adds periods at the ends of items, and converts module-level block comments to line comments because docs.rs adds an extra exclamation point when those are used (due to a bug, I think).
It doesn't touch every doc item, but it's a start. Let me know how I can improve it (this is my first pull request to naga). Thank you!