Use 100 column width for rustdoc

We use 100 column width for rustdoc in this project, while not a super
hard rule the docs on `read_scriptint` are long, using the 100 column
width reduces the line count a reasonable amount.

No text changes, only whitespace.
This commit is contained in:
Tobin C. Harding 2024-06-22 06:26:44 +10:00
parent c71ae9ac16
commit aebf216619
No known key found for this signature in database
GPG Key ID: 40BF9E4C269D6607
1 changed files with 9 additions and 13 deletions

View File

@ -295,19 +295,15 @@ impl PushBytes {
/// Decodes an integer in script(minimal CScriptNum) format. /// Decodes an integer in script(minimal CScriptNum) format.
/// ///
/// Notice that this fails on overflow: the result is the same as in /// Notice that this fails on overflow: the result is the same as in bitcoind, that only 4-byte
/// bitcoind, that only 4-byte signed-magnitude values may be read as /// signed-magnitude values may be read as numbers. They can be added or subtracted (and a long
/// numbers. They can be added or subtracted (and a long time ago, /// time ago, multiplied and divided), and this may result in numbers which can't be written out
/// multiplied and divided), and this may result in numbers which /// in 4 bytes or less. This is ok! The number just can't be read as a number again. This is a
/// can't be written out in 4 bytes or less. This is ok! The number /// bit crazy and subtle, but it makes sense: you can load 32-bit numbers and do anything with
/// just can't be read as a number again. /// them, which back when mult/div was allowed, could result in up to a 64-bit number. We don't
/// This is a bit crazy and subtle, but it makes sense: you can load /// want overflow since that's surprising --- and we don't want numbers that don't fit in 64
/// 32-bit numbers and do anything with them, which back when mult/div /// bits (for efficiency on modern processors) so we simply say, anything in excess of 32 bits
/// was allowed, could result in up to a 64-bit number. We don't want /// is no longer a number. This is basically a ranged type implementation.
/// overflow since that's surprising --- and we don't want numbers that
/// don't fit in 64 bits (for efficiency on modern processors) so we
/// simply say, anything in excess of 32 bits is no longer a number.
/// This is basically a ranged type implementation.
/// ///
/// This code is based on the `CScriptNum` constructor in Bitcoin Core (see `script.h`). /// This code is based on the `CScriptNum` constructor in Bitcoin Core (see `script.h`).
pub fn read_scriptint(&self) -> Result<i64, script::Error> { pub fn read_scriptint(&self) -> Result<i64, script::Error> {