docs: fix new clippy lint about excessively long initial line #730
Conversation
Also does a few miscellaneous fixes that I noticed while fixing the lint.
| /// No assumptions may be made about dissatisfying this fragment. This | ||
| /// No assumptions may be made about dissatisfying this fragment. | ||
| /// | ||
| /// This | ||
| /// does not necessarily mean that there are multiple dissatisfactions; | ||
| /// there may be none, or none that are always available (e.g. for a | ||
| /// `pk_h` the key preimage may not be available). |
There was a problem hiding this comment.
This is an example that would be better with the column width fixing.
|
We could go through all the docs and make them look nice, yes. But this is causing local CI failures (and, I think, real CI failures) so I would like to just get it working. |
|
Sure thing. |
|
ACK since this is not |
| @@ -351,7 +352,9 @@ fn interpreter_inp_check<C: secp256k1::Verification, T: Borrow<TxOut>>( | |||
| Ok(()) | |||
| } | |||
|
|
|||
| /// Finalize the psbt. This function takes in a mutable reference to psbt | |||
| /// Finalize the psbt. | |||
There was a problem hiding this comment.
Maybe
| /// Finalize the psbt. | |
| /// Finalizes the psbt. |
to adhere with other docstrings?
| @@ -67,7 +69,9 @@ pub trait AssetProvider<Pk: MiniscriptKey> { | |||
| } | |||
|
|
|||
| /// Given a keyhash, look up the EC signature and the associated key. | |||
There was a problem hiding this comment.
| /// Given a keyhash, look up the EC signature and the associated key. | |
| /// Given a keyhash, looks up the EC signature and the associated key. |
| //! A spending plan (or *plan*) is a representation of a particular spending path on a | ||
| //! descriptor. | ||
| //! | ||
| //! This allows us to analayze a choice of spending path without producing any |
There was a problem hiding this comment.
| //! This allows us to analayze a choice of spending path without producing any | |
| //! This allows us to analyze a choice of spending path without producing any |
There was a problem hiding this comment.
Ok can I review-beg this typo at least 😢 @apoelstra?
| @@ -76,7 +80,9 @@ pub trait AssetProvider<Pk: MiniscriptKey> { | |||
| } | |||
|
|
|||
| /// Given a keyhash, look up the schnorr signature and the associated key. | |||
There was a problem hiding this comment.
| /// Given a keyhash, look up the schnorr signature and the associated key. | |
| /// Given a keyhash, looks up the Schnorr signature and the associated key. |
| /// Returns the key if a signature is found. | ||
| /// | ||
| /// Even if signatures for public key Hashes are not available, the users |
| @@ -58,7 +59,8 @@ pub trait Satisfier<Pk: MiniscriptKey + ToPublicKey> { | |||
| /// Given a raw `Pkh`, lookup corresponding [`bitcoin::secp256k1::XOnlyPublicKey`] | |||
There was a problem hiding this comment.
I cannot annotate above but in L40 there's a "look" -> "looks" and "schnorr" -> "Schnorr"
|
This is a CI fix PR @storopoli, also the |
|
Indeed. There are lots of poorly-formatted and ungrammatical docs in this repo. Many of them apply to error enums and other types which themselves are a huge mess. I'd rather not change stuff unless we're fixing the underlying type, because it would be a lot of (potentially-wasted) work and extra rebasing for me. |
|
I never did get around to putting 3 months into |
|
At some point I will open an issue to really fix the docs; but as mentioned, right now the majority of the documentation by volume seems to be on error variants, and I hope to significantly change those over the coming months and years. |
Also does a few miscellaneous fixes that I noticed while fixing the lint.