Skip to content
This repository was archived by the owner on Nov 15, 2023. It is now read-only.
This repository was archived by the owner on Nov 15, 2023. It is now read-only.

Make procedural documentation compile #1441

@cheme

Description

@cheme

Currently some procedural macro documentation code snippets are defined as nocompile. For instance decl_storage documentation example.
Making the example build will allow to avoid many regression.
At the time, the task is not easy due to the way hidden_include works (documentation code snippet is seen as a part of the crate so no include is generated, but that is not the way rust doc works).
Moving doc does not really help to.
This could probably be solve in future rust version, depending on proc_macro evolution. It may also be solved by making the hidden_module tools compatible with documentation (not sure it is worth it).

Issue created for #1437.

Metadata

Metadata

Assignees

No one assigned

    Labels

    I5-testsTests need fixing, improving or augmenting.Z2-mediumCan be fixed by a coder with good Rust knowledge but little knowledge of the codebase.

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions