Skip to content

Display feature information in documentation #241

@anakrish

Description

@anakrish

In the public API for regorus in docs.rs, display that certain API is available only if a specific feature is available.
For example, https://docs.rs/regorus/latest/regorus/struct.Engine.html#method.get_coverage_report does not list that coverage feature is necessary for this API.

There has been an attempt to make this work:

# RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --all-features --no-deps

@mkulke What is the right way to do this?

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions