docs(options): fix some typos and improve consistency#12191
Merged
charliermarsh merged 2 commits intoastral-sh:mainfrom Jul 4, 2024
Merged
docs(options): fix some typos and improve consistency#12191charliermarsh merged 2 commits intoastral-sh:mainfrom
charliermarsh merged 2 commits intoastral-sh:mainfrom
Conversation
charliermarsh
approved these changes
Jul 4, 2024
Member
charliermarsh
left a comment
There was a problem hiding this comment.
Wow, this is excellent -- thank you! I skimmed through all the changes. How did you find these?
Member
I think this is true (that it will appear in the JSON Schema). But I think it's worth it. |
Contributor
Author
By manually skimming through the documentation (yeah, for real 😄). |
Member
|
I'm very impressed, thanks! |
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
2 participants
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.
Summary
Fixes a few typos and consistency issues in the "Settings" documentation:
2nd commit might be controversial, as there are many options mentioned where we don't currently link to the documentation sections, so maybe it's done on purpose, as this will also appear in the JSON schema where it's not desirable? If that's the case, I can easily drop it.
Test Plan
Local testing.