Add a bit of documentation / formatting to Random
#187
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
mr-git
reviewed
Feb 28, 2025
Co-authored-by: Mareks Rampāns <8796159+mr-git@users.noreply.github.com>
Co-authored-by: Mareks Rampāns <8796159+mr-git@users.noreply.github.com>
Co-authored-by: Mareks Rampāns <8796159+mr-git@users.noreply.github.com>
mr-git
approved these changes
Feb 28, 2025
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.
Added some documentation to the main methods of
Random.It is still a very undocumented library though as there is no description of why it should be used, and how.
I.e. if and when https://typelevel.org/cats-effect/docs/std/random should be used instead.