search

rust-bitcoin / rust-secp256k1

Rust language bindings for Bitcoin secp256k1 library.
Creative Commons Zero v1.0 Universal
351 stars 270 forks source link

fix docs for new clippy lint #740

Closed apoelstra closed 2 months ago

apoelstra commented 2 months ago

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.

Kixunil commented 2 months ago

Concept ACK but it also fails CI. :)

apoelstra commented 2 months ago

strace shows that xargo is failing trying to access some internal lockfile:

/store/home/apoelstra/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/lib/rustlib/src/rust/Cargo.lock

Looks to me like xargo is just broken and I need to revert the update to the nightly compiler.

apoelstra commented 2 months ago

Yeah -- I believe this is fixed upstream by https://github.com/rust-lang/cargo/pull/14370 so we just need to wait. Meanwhile I'll revert the nightly update.

Kixunil commented 2 months ago

That issue says august 8th.

apoelstra commented 2 months ago

Yes. How long is the delay between stuff getting merged into cargo and it showing up in a rustc nightly? I have no idea.

Kixunil commented 2 months ago

How long is the delay between stuff getting merged into cargo and it showing up in a rustc nightly?

IIUC it's should be the following night - hence the name "nightly"

apoelstra commented 2 months ago

I think that only applies to rustc itself. Everything else has a delay. In particular clippy has a delay, and ISTR that one of their developers told us it was because the clippy changes would ship alongside the cargo changes.

apoelstra commented 2 months ago

Reminder to me to merge https://github.com/rust-bitcoin/rust-secp256k1/pull/737 after this gets in

Kixunil commented 2 months ago

Do you want to address my comments?

apoelstra commented 2 months ago

Sure. Removed "likely to be" from the UB comment. Should be good to go now.