generate docs for feature gated items #1332
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
niklasad1
force-pushed
the
na-generate-docs-for-feature-gated-items
branch
from
32e6762 to
2cc5d2f
Compare
jsdw
reviewed
Jan 3, 2024
jsdw
reviewed
Jan 3, 2024
subxt/src/tx/signer.rs
Outdated
| @@ -25,6 +25,7 @@ pub trait Signer<T: Config> { | |||
| } | |||
|
|
|||
| #[cfg(feature = "substrate-compat")] | |||
| #[cfg_attr(docsrs, doc(cfg(feature = "substrate-compat")))] | |||
There was a problem hiding this comment.
This line that we have to add below each feature is sortof ugly! I'm not really familiar with it; what does it do? I also wonder whether we could avoid this line duplication somehow.
There was a problem hiding this comment.
agree, we could write a macro for it as we have in jsonrpsee
…ed-items' into na-generate-docs-for-feature-gated-items
niklasad1
commented
Jan 9, 2024
…ed-items' into na-generate-docs-for-feature-gated-items
…r-feature-gated-items
tadeohepperle
approved these changes
Jan 12, 2024
lexnv
approved these changes
Jan 12, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I noticed that the stuff hidden behind the
unstable-light-clientdoesn't show up on docs.rs/subxt which this PR fixes.docsrsis still unstable and needs to enabled if one wants to use it, rust-lang/rust#43781