Generate docs with features for docs.rs #1303
Merged
Conversation
This file contains hidden or 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
Codecov Report
@@ Coverage Diff @@
## main #1303 +/- ##
=======================================
Coverage 90.51% 90.52%
=======================================
Files 72 72
Lines 39608 39608
=======================================
+ Hits 35853 35854 +1
+ Misses 3755 3754 -1
Continue to review full report at Codecov.
|
TheBlueMatt
reviewed
Feb 12, 2022
lightning/src/ln/msgs.rs
Outdated
| @@ -985,7 +985,7 @@ impl fmt::Display for DecodeError { | |||
| DecodeError::InvalidValue => f.write_str("Nonsense bytes didn't map to the type they were interpreted as"), | |||
| DecodeError::ShortRead => f.write_str("Packet extended beyond the provided bytes"), | |||
| DecodeError::BadLengthDescriptor => f.write_str("A length descriptor in the packet didn't describe the later data correctly"), | |||
| DecodeError::Io(ref e) => e.fmt(f), | |||
| DecodeError::Io(ref e) => Debug::fmt(&e, f), | |||
There was a problem hiding this comment.
This is also changed in #1301, let's not conflict.
TheBlueMatt
reviewed
Feb 12, 2022
| @@ -246,7 +246,6 @@ type ConfiguredTime = time::Eternity; | |||
| /// [`Score`] implementation. | |||
| /// | |||
| /// (C-not exported) generally all users should use the [`Scorer`] type alias. | |||
| #[doc(hidden)] | |||
There was a problem hiding this comment.
Why are we removing this?
There was a problem hiding this comment.
See commit message. Type alias docs don't show any methods and you can't click on the underlying type without removing this.
|
Needs rebase after #1301 landed, otherwise ACK. |
The docs were hidden since a type alias should be used. However, the alias docs don't contain much useful information and don't link to the corresponding struct.
Enable generating docs using --all-features or --features="std" where applicable. Additionally, use doc_auto_cfg to tag items requiring a feature. https://doc.rust-lang.org/nightly/rustdoc/unstable-features.html#doc_auto_cfg-automatically-generate-doccfg This requires building with nightly, which is what is used by docs.rs. https://docs.rs/about/builds To test locally, use: RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc ...
jkczyz
force-pushed
the
2022-02-docs-with-features
branch
from
8653104 to
62b1e01
Compare
arik-so
approved these changes
Feb 28, 2022
TheBlueMatt
approved these changes
Feb 28, 2022
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.
Enable generating docs using
--all-featuresor--features="std"where applicable. Additionally, usedoc_auto_cfgto tag items requiring a feature.https://doc.rust-lang.org/nightly/rustdoc/unstable-features.html#doc_auto_cfg-automatically-generate-doccfg
This requires building with
nightly, which is what is used by docs.rs.https://docs.rs/about/builds
To test locally, use:
RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc ...