fix docs for new clippy lint #740
Conversation
|
Concept ACK but it also fails CI. :) |
|
strace shows that xargo is failing trying to access some internal lockfile: Looks to me like xargo is just broken and I need to revert the update to the nightly compiler. |
secp256k1-sys/src/lib.rs
Outdated
| /// If you create one of these with `secp256k1_context_create` you must | ||
| /// destroy it with `secp256k1_context_destroy`. (Failure to destroy it is | ||
| /// a memory leak; destroying it using any other allocator is likely to be | ||
| /// undefined behavior.) |
There was a problem hiding this comment.
I'd just write "is undefined behavior". I don't think it's useful to try to define some crazy circumstances when it's not.
| /// secret key passed to `ElligatorSwift::shared_secret`. | ||
| /// Represents which party we are in the ECDH. | ||
| /// | ||
| /// Here `A` is the initiator and `B` is the responder. |
There was a problem hiding this comment.
I guess we should've named the enum variants as such. :(
| /// of being zero, overflowing the group order, or equalling any specific value. | ||
| /// | ||
| /// Since version 0.29 this has been deprecated; users should instead implement | ||
| /// `Into<Message>` for types that satisfy these properties. |
There was a problem hiding this comment.
I wonder when are we going to remove this entirely.
There was a problem hiding this comment.
It was deprecated in April. Let's give it at least a year (unless it winds up blocking 1.0). I'd give it 2. It's self-contained and not hurting anything.
|
Yeah -- I believe this is fixed upstream by rust-lang/cargo#14370 so we just need to wait. Meanwhile I'll revert the nightly update. |
|
That issue says august 8th. |
|
Yes. How long is the delay between stuff getting merged into cargo and it showing up in a rustc nightly? I have no idea. |
IIUC it's should be the following night - hence the name "nightly" |
|
I think that only applies to |
|
Reminder to me to merge #737 after this gets in |
|
Do you want to address my comments? |
There are a bunch of doccomments whose first lines are (much) too long. Most of these are also difficult to understand and/or out-of-date. Just rewrite them all.
This reverts commit 78d93b7.
apoelstra
force-pushed
the
2024-09--fix-docs
branch
from
9e08c87 to
3810686
Compare
|
Sure. Removed "likely to be" from the UB comment. Should be good to go now. |
There are a bunch of doccomments whose first lines are (much) too long. Most of these are also difficult to understand and/or out-of-date. Just rewrite them all.