Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation Updates #222

Merged

Conversation

1eyewonder
Copy link
Contributor

@1eyewonder 1eyewonder commented Jul 11, 2023

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

  • I have added necessary documentation (if appropriate)

@TheAngryByrd
Copy link
Collaborator

This is so amazing, thank you!

@TheAngryByrd TheAngryByrd merged commit 7bad77c into demystifyfp:master Jul 11, 2023
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants