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

Document panics #999

Open

tomtau opened this issue Mar 24, 2024 · 0 comments

Labels

documentation good-first-issue help-wanted

Contributor

tomtau commented Mar 24, 2024

Currently, panics may not be consistently documented (as a follow-up to PR that removed unnecessary unsafe).

Whether Pest documents panics in a # Panics section following the standard library pattern. Note that unlike safety docs, panic docs are not required for soundness.

It doesn't, at least not consistently, but it should.

Originally posted by @tomtau in #998 (comment)

tomtau added documentation good-first-issue help-wanted labels

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment