Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs feature #101

Merged
merged 4 commits into from
Jun 23, 2021
Merged

Add docs feature #101

merged 4 commits into from
Jun 23, 2021

Conversation

ascjones
Copy link
Contributor

Docs will not be generated by the proc macro unless the docs feature is enabled.

This allows reducing the size of the metadata code, useful for substrate runtimes: paritytech/substrate#8370 (comment)

Copy link
Contributor

@dvdplm dvdplm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My only concern is whether we should include the docs feature in the defaults or not. I'd be inclined to include it by default.

Comment on lines 24 to 26
default = []
# Include code docs in type metadata.
docs = []
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wouldn't we want the docs to be included by default? In the steady-state future scenario we'll want the full metadata I think, and excluding it is something we want to do only while figuring out where to store it yes?

Cargo.toml Outdated Show resolved Hide resolved
@ascjones ascjones merged commit 11c730f into master Jun 23, 2021
@ascjones ascjones deleted the aj-docs-feature branch June 23, 2021 15:21
This was referenced Jun 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants