Several minor documentation fixes #6437
Merged
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
|
|
|
@zawlazaw Thanks for submitting! Will review this tomorrow! |
|
@zawlazaw |
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.
This PR fixes several minor issues in the documentation of ZIO v2.x. In order to avoid too big PRs and to get some early feedback on my very first ZIO contribution, I focused so far only on the Sections
Data Types / {Overview, Core Data Types, Contextual Types}. After this PR is merged, I would continue with the next sections in a similar way.**Note**instead of variants such as_**Note**_mdoc:failcodeblocks intomdoc:fail:silentto suppress the auto-generated output which contained a lot of unrelated messages, and added only the intended error output manually as comments insteadI tried to exclude any refactorings that could trigger an opinionated discussion (e.g. whether we may also denote URIO an unexeptional effect), and collect such semantical discussions for future work.