docs: Clean up some grammar & syntax in core reference #8276
Conversation
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
|
@khajavi since you've done some content overhauls in docs lately, please let me know if there's something you're working on now so I don't duplicate effort on it 🙏🏼 |
jdegoes
approved these changes
Jul 28, 2023
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 b
2E1C
atch.
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.
Greetings ZIO community,
I've been making a close-reading pass through ZIO core docs, with my text editor close at hand. I find them to be in good shape "in the large"—comprehensive coverage, organization—but to have a lot of speed bumps in the small that I could improve as I go. Style and phrasing are subjective, grammar & syntax are more objective, so I will try to separate these types of changes into PRs that are likely to warrant more or less discussion, respectively.
If still smaller patches would be preferred, let me know.
This one is a first pass of a few sections/chapters on the objective front. Some minor rephrasing may creep in if it fell on the same line as a grammar fix, usually attempting to be more concise, reducing wordiness or repetition.
Disclaimer: I am not a credentialed technical writer, I sometimes might not be able to give better rationale than "it just sounds odd to me as a native English speaker…" 😅
Also, friendly reminder that GitHub has the "rich diffs" toggle that can be useful for reviewing lots of prose changes.