pest-parser / pest

The Elegant Parser
https://pest.rs
Apache License 2.0
4.67k stars 262 forks source link

Document panics #999

Open tomtau opened 8 months ago

tomtau commented 8 months ago

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 https://github.com/pest-parser/pest/pull/998#issuecomment-2016653683