-
Notifications
You must be signed in to change notification settings - Fork 409
Fix doc warnings and doc cleanup in msgs.rs
/ser.rs
#1950
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
Fix doc warnings and doc cleanup in msgs.rs
/ser.rs
#1950
Conversation
Codecov ReportBase: 90.73% // Head: 90.69% // Decreases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## main #1950 +/- ##
==========================================
- Coverage 90.73% 90.69% -0.05%
==========================================
Files 97 97
Lines 50540 50540
Branches 50540 50540
==========================================
- Hits 45859 45836 -23
- Misses 4681 4704 +23
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
548a072
to
9dfc23e
Compare
Feel free to squash. |
Just added another commit to fix building docs with |
07e34fe
to
e2f232a
Compare
Feel free to squash. CI failing with:
|
e2f232a
to
cc3b4e6
Compare
Ah, lol. Now hopefully fixed by squashing commits and including: > git diff-tree -U2 e2f232ae cc3b4e6e
diff --git a/lightning/src/util/ser_macros.rs b/lightning/src/util/ser_macros.rs
index 9b4a6295..8d74a83a 100644
--- a/lightning/src/util/ser_macros.rs
+++ b/lightning/src/util/ser_macros.rs
@@ -802,5 +802,5 @@ macro_rules! _impl_writeable_tlv_based_enum_common {
/// variants stored directly.
/// The format is, for example
-/// ```
+/// ```ignore
/// impl_writeable_tlv_based_enum!(EnumName,
/// (0, StructVariantA) => {(0, required_variant_field, required), (1, optional_variant_field, option)}, |
cc3b4e6
to
defa2f6
Compare
... and had to include two more > git diff-tree -U1 cc3b4e6e defa2f68
diff --git a/lightning-invoice/src/lib.rs b/lightning-invoice/src/lib.rs
index 50ef3e4a..c01dfa47 100644
--- a/lightning-invoice/src/lib.rs
+++ b/lightning-invoice/src/lib.rs
@@ -808,3 +808,3 @@ impl SignedRawInvoice {
///
-/// ```
+/// ```ignore
/// enum Enum {
@@ -829,3 +829,3 @@ macro_rules! find_extract {
///
-/// ```
+/// ```ignore
/// enum Enum { |
@@ -727,22 +814,26 @@ pub struct QueryShortChannelIds { | |||
pub short_channel_ids: Vec<u64>, | |||
} | |||
|
|||
/// A reply_short_channel_ids_end message is sent as a reply to a | |||
/// query_short_channel_ids message. The query recipient makes a best | |||
/// A [`reply_short_channel_ids_end message`] is sent as a reply to a |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Extra text in the []
This PR fixes a number of doc warnings, and since I was already touching the docs there I included some cleanups of the docs in
msgs.rs
andser.rs
.Mostly nits, a lot of ticking and linking.