dtolnay / dtolnay/syn

Documentation discrepancy between `parse` and `parse2`

Open
#1,723 0 comments 0 reactions 0 assignees View on GitHub
docs
Dominant language
Rust
Stars
3.4k
Forks
374
Avg merge
1d 5h
Merged PRs (30d)
2

Description

Both functions are very similar, yet `parse2` explicitly states
> This function will check that the input is fully parsed. If there are any unparsed tokens at the end of the stream, an error is returned.

`parse` does behave the same way (it also errors if the input wasn't completely consumed) but instead of saying so it only notes
> This is preferred over parsing a string because tokens are able to preserve information about where in the user’s code they were originally written (the “span” of the token), possibly allowing the compiler to produce better error messages.

As far as I can tell both sentences are equally relevant for both functions so I think both texts should be synchronized.

Alternatively the whole text could be collected under `parse` with `parse2` just referring to `parse`s documentation.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.