Skip to content

doc: doc-tests in bytes/mod.rs and character/mod.rs should not reference functions from submodules #1834

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

Open
DanikVitek opened this issue Mar 5, 2025 · 0 comments

Comments

@DanikVitek
Copy link

DanikVitek commented Mar 5, 2025

These modules provide universal implementation of the parser combinators. Meanwhile, complete and streaming submodules provide the particular implementations, which might potentially be different from universal (implemented manually/inlined), rather than reference a universal implementation.
Therefore, the doc tests neither perform checks of the universal implementations, nor they show how to use the universal implementation.

For instance:

/// use nom::bytes::streaming::tag;

/// use nom::bytes::streaming::tag_no_case;

/// # use nom::character::streaming::char;

/// # use nom::character::complete::satisfy;

@DanikVitek DanikVitek changed the title doc: doc-tests in bytes/mod.rs, character/mod.rs, and number/mod.rs should not reference functions from submodules doc: doc-tests in bytes/mod.rs and character/mod.rs should not reference functions from submodules Mar 5, 2025
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

No branches or pull requests

1 participant