codegen: Opt out of documentation #843
Conversation
Signed-off-by: Alexandru Vasile <[email protected]>
Signed-off-by: Alexandru Vasile <[email protected]>
Signed-off-by: Alexandru Vasile <[email protected]>
Signed-off-by: Alexandru Vasile <[email protected]>
Signed-off-by: Alexandru Vasile <[email protected]>
codegen/src/api/mod.rs
Outdated
| @@ -82,6 +82,7 @@ where | |||
| derives, | |||
| type_substitutes, | |||
| crate_path, | |||
| true, | |||
There was a problem hiding this comment.
I reckon we should make sure that the #[subxt] macro doesn't generate any docs, in this case (since they are sortof unnecessary there by default). We can always expose a flag in the macro args then to add docs if IDE's can ever learn to ebnefit from it :)
There was a problem hiding this comment.
That makes total sense! I've disabled by default the documentation generation for the subxt macro and added a flag to its attributes: expose_documentation, that when present the generated code will expose the metadata documentation
Signed-off-by: Alexandru Vasile <[email protected]>
Signed-off-by: Alexandru Vasile <[email protected]>
macro/src/lib.rs
Outdated
| //! code, users must specify the `expose_documentation` flag: | ||
| //! | ||
| //! ```ignore | ||
| //! #[subxt::subxt(expose_documentation)] |
There was a problem hiding this comment.
Nit: I feel like something like generate_docs would make more sense, since that's really what's happening here
There was a problem hiding this comment.
I agree that generate_docs is a better choice:)
There was a problem hiding this comment.
I tweaked this quickly via the in-browser editor :)
This PR exposes the
--no-docsflag by the CLI.When the flag is active the generated subxt API will not include the documentation from the metadata.
While at it, have also modified the
codegentests to check that no documentation present in the metadata-v14 is extracted on the generated API.Closes: #826.