RMD-358 optics documentation fixes (GH-239) #239
Merged
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
Jeremy-Walton
approved these changes
Nov 19, 2024
Jeremy-Walton
approved these changes
Nov 21, 2024
yawnybear
changed the title
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.
Task
RMD-358
Why?
Our current documentation for Optics has some refinements and fixes that could be made to help make it feel more consistent throughout. This includes using consistent capital case, resolving some typos, rephrasing some sentences to make it more clear to readers, and update links to external sites.
What Changed
What changed in this PR?
Sanity Check
[ ] Have you updated any usage of changed tokens?[ ] Have you updated the docs with any component changes?[ ] Have you updated the dependency graph with any component changes?[ ] Do you need to update the package version?