Fix trivial doc warnings and make CI use old rustc #955
Conversation
These constants are generally useful, and are linked from documentation, so should be exposed in any case.
Codecov Report
@@ Coverage Diff @@
## main #955 +/- ##
==========================================
- Coverage 90.59% 90.57% -0.02%
==========================================
Files 60 60
Lines 30423 30423
==========================================
- Hits 27561 27555 -6
- Misses 2862 2868 +6
Continue to review full report at Codecov.
|
| @@ -12,13 +12,13 @@ | |||
| //! Note this is not part of the specs, but follows lnd's signing and verifying protocol, which can is defined as follows: | |||
| //! | |||
| //! signature = zbase32(SigRec(sha256d(("Lightning Signed Message:" + msg))) | |||
| //! zbase32 from https://philzimmermann.com/docs/human-oriented-base-32-encoding.txt | |||
| //! zbase32 from `<https://philzimmermann.com/docs/human-oriented-base-32-encoding.txt>` | |||
There was a problem hiding this comment.
This doesn't create a hyperlink, it shows it as code: <https://philzimmermann.com/docs/human-oriented-base-32-encoding.txt>
| //! zbase32 from `<https://philzimmermann.com/docs/human-oriented-base-32-encoding.txt>` | |
| //! zbase32 from <https://philzimmermann.com/docs/human-oriented-base-32-encoding.txt> |
There was a problem hiding this comment.
Ah! Thanks. Is there a feature request to change the warning message to drop the "`"s on rustdoc, or should I open one? Was definitely confusing for me, I wonder if there's a better way to communicate that the "`" is intended as a quote, not a part of the suggestion.
There was a problem hiding this comment.
There's no issue, you should open a new one.
That seems be hard to do, this is part of diagnostic machinery. How would you decide what suggestions get a backtick and which don't?
There was a problem hiding this comment.
Yea, I went and read some of the rustc source after commenting and realized its probably not trivial. I'll leave it alone for now, I was hoping it was pretty trivial and I could open a feature request someone could knock out quick, but I don't want to go demand something thats a papercut and takes significant effort to fix.
TheBlueMatt
force-pushed
the
2021-06-rustc-bugz
branch
from
b17b3c3 to
20fe546
Compare
Latest rustc warns that "this URL is not a hyperlink" and notes that "bare URLs are not automatically turned into clickable links". This resolves those warnings. Thanks to Joshua Nelson for pointing out the correct syntax for this.
TheBlueMatt
force-pushed
the
2021-06-rustc-bugz
branch
from
20fe546 to
84ac66e
Compare
|
|
||
| /// Default minimum final CLTV expiry as defined by [BOLT 11]. | ||
| /// | ||
| /// [BOLT 11]: https://github.com/lightningnetwork/lightning-rfc/blob/master/11-payment-encoding.md | ||
| const DEFAULT_MIN_FINAL_CLTV_EXPIRY: u64 = 18; | ||
| pub const DEFAULT_MIN_FINAL_CLTV_EXPIRY: u64 = 18; |
There was a problem hiding this comment.
Should we change this constant since RL isn't okay with less than 22 (iiuc)?
There was a problem hiding this comment.
No, the default value is always 18, we require something higher but that means we have to explicitly specify it in the invoice (which we do).
There was a problem hiding this comment.
Added a comment making this explicit as users are likely to be confused here.
rustc stable regressed in creating docs, see rust-lang/rust#84738. This causes our docs to fail to build. This isn't our problem, really, but we shouldn't be failing CI while rustc gets its act together.