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.
Proposed Changes
When doing through documentation, I noticed there were some items which were listed, but not applicable to certain modules as well as unlisted functions in modules. I created a 'PR' markdown document which will be shown on the documentation site. The reasoning behind this is to allow users to know the feature is supported, but we just haven't gotten to the documentation yet.
Additionally, I started adding examples to the Result module. I feel the documentation is lacking in examples overall so I figured brining over some of our unit tests helps provide visuals for users who may not grasp the function signatures at first glance.
I have also alphabetized the functions under their respective modules for easier discoverability.
Checklist