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.

Sign up for GitHub

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

Jump to bottom

Add Panics sections to the documentation where applicable #8

Closed
ripytide opened this issue Mar 31, 2023 · 0 comments · Fixed by #15
Closed

Add Panics sections to the documentation where applicable #8

ripytide opened this issue Mar 31, 2023 · 0 comments · Fixed by #15
Labels
documentation Improvements or additions to documentation

Comments

@ripytide
Copy link
Owner

ripytide commented Mar 31, 2023 •
edited

There are many functions which may panic if given certain inputs (I'm pretty sure only InvalidRangeBounds currently), we should make this explicit where it is intended behaviour, such as with InvalidRangeBounds. See upstreams BTreeMaps documentation for an example here.
@ripytide ripytide added the documentation Improvements or additions to documentation label Mar 31, 2023
@ripytide ripytide mentioned this issue Mar 31, 2023
Closed
@ripytide ripytide changed the title Add "Panics" sections to the documentation where applicable Add Panics sections to the documentation where applicable Mar 31, 2023
@ripytide ripytide mentioned this issue Mar 31, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add Panics sections to the documentation where applicable ripytide/nodit
1 participant
@ripytide