Fix jet documentation whitespace#276
Open
schoen wants to merge 4 commits intoBlockstreamResearch:masterfrom
Open
Fix jet documentation whitespace#276schoen wants to merge 4 commits intoBlockstreamResearch:masterfrom
schoen wants to merge 4 commits intoBlockstreamResearch:masterfrom
Conversation
stringhandler
approved these changes
Apr 7, 2026
KyrylR
reviewed
Apr 7, 2026
| Elements::FullRightShift64_16 => "Helper for right-shifting bits. The bits are shifted from a 16-bit value into a 64-bit value. Return the shifted value and the 16 bits that were shifted out.", | ||
| Elements::FullRightShift64_32 => "Helper for right-shifting bits. The bits are shifted from a 32-bit value into a 64-bit value. Return the shifted value and the 32 bits that were shifted out.", | ||
| Elements::High1 => "Return `u1::MAX` = 1.", | ||
| Elements::High1 => "Return [`u1::MAX`] = 1.", |
Collaborator
There was a problem hiding this comment.
Checking either v1.13.0
Documenting simplicityhl-as-rust v0.2.0 (/private/tmp/SimplicityHL-as-rust)
error: unresolved link to `u1::MAX`
--> src/jet/multi_bit_logic.rs:561:14
|
561 | /// Return [`u1::MAX`] = 1.
| ^^^^^^^ the struct `u1` has no field or associated item named `MAX`
|
= note: requested on the command line with `-D rustdoc::broken-intra-doc-links`
error: unresolved link to `u1::MIN`
--> src/jet/multi_bit_logic.rs:1146:14
|
1146 | /// Return [`u1::MIN`] = 0.
| ^^^^^^^ the struct `u1` has no field or associated item named `MIN`
error: could not document `simplicityhl-as-rust`
Command: RUSTDOCFLAGS='-D rustdoc::broken_intra_doc_links' cargo doc --no-deps
Maybe it is better just to remove u1::MAX? same for min
Contributor
Author
|
@KyrylR Thank you for catching that problem. I would like to regularize the See also #252 However, I should not let the documentation erroneously get ahead of the code here! So I added a commit to revert that reference for |
Contributor
Author
|
Sorry, I realize I'll also have to sign these commits. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Some whitespace edits in the jet documentation.