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

Make procedural documentation compile #1441

Open
Tracked by #264
cheme opened this issue Jan 15, 2019 · 0 comments
Open
Tracked by #264

Make procedural documentation compile #1441

cheme opened this issue Jan 15, 2019 · 0 comments
Labels
I5-tests Tests need fixing, improving or augmenting. Z2-medium Can be fixed by a coder with good Rust knowledge but little knowledge of the codebase.
Milestone

Comments

@cheme
Copy link
Contributor

cheme commented Jan 15, 2019

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.

@cheme cheme added the I5-tests Tests need fixing, improving or augmenting. label Jan 15, 2019
@bkchr bkchr added the Z2-medium Can be fixed by a coder with good Rust knowledge but little knowledge of the codebase. label Jan 15, 2019
@bkchr bkchr added this to the As-and-when milestone Jan 15, 2019
liuchengxu pushed a commit to liuchengxu/substrate that referenced this issue May 31, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
I5-tests Tests need fixing, improving or augmenting. Z2-medium Can be fixed by a coder with good Rust knowledge but little knowledge of the codebase.
Projects
None yet
Development

No branches or pull requests

2 participants