Skip to content

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

Open
@DanikVitek

Description

@DanikVitek

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;

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions