Enable -D rustdoc::broken-intra-doc-links#507
Merged
apoelstra merged 3 commits intorust-bitcoin:masterfrom Dec 23, 2022
Merged
Conversation
-D rustdoc::broken-intra-doc-links)-D rustdoc::broken-intra-doc-links
-D rustdoc::broken-intra-doc-links-D rustdoc::broken-intra-doc-links
8e2ad01 to
6b215df
Compare
tcharding
commented
Dec 21, 2022
src/policy/concrete.rs
Outdated
| /// Descriptor context for [`Policy`] compilation into a [`crate::Descriptor`]. | ||
| pub enum DescriptorCtx<Pk> { | ||
| /// [Bare][`Descriptor::Bare`] | ||
| /// See docs for [`crate::Descriptor::Bare`]. |
Member
Author
There was a problem hiding this comment.
I'm not super happy with all the crate::s here.
Member
Author
There was a problem hiding this comment.
Does anyone remember how to import a type just for the docs build, we do it someplace else but I can't find it?
Member
Author
There was a problem hiding this comment.
Its
#[cfg(doc)]
use Foo;
Member
|
Needs rebase. |
- Improve rendered headers by removing the empty `# Introduction` section - Add full stops
The docs for `enumerate_policy_tree` are referenced by other functions but because `enumerate_policy_tree` is private we cannot link to the docs of this method. In preparation for duplicating the docs in multiple places; improve the docs on `enumerate_policy_tree` by doing: - Separate brief and long sections - Fix links
6b215df to
316edcb
Compare
Member
Author
|
I rebased but I'd prefer to import |
Currently we have a bunch of broken links in our docs. Fix all the broken links an add `-D rustdoc::broken-intra-doc-links` to the docs build in CI. There are a few other improvements scattered through this PR, I tried to find a balance between scope creep and obvious errors in the diff.
316edcb to
ebaa31b
Compare
Member
Author
|
Used |
apoelstra
approved these changes
Dec 23, 2022
Member
Author
|
oh, how did that merge? Did you fix the formatting issue? |
Member
|
What formatting issue? |
Member
|
Oh, I see, cirrus is gated on rustfmt, and I didn't bother checking it locally. I'll fix it. |
apoelstra
added a commit
to apoelstra/rust-miniscript
that referenced
this pull request
Dec 23, 2022
sanket1729
added a commit
that referenced
this pull request
Dec 29, 2022
f0f7fd6 fix formatting after #507 (Andrew Poelstra) Pull request description: I merged #507 without checking CI, and it turns out there was a rustfmt issue. FIx that. ACKs for top commit: tcharding: ACK f0f7fd6 sanket1729: ACK f0f7fd6 Tree-SHA512: 909d0a118c0e36f40b7aa6f0d6c7718b1b77b00acbb07ae0183a26e107a24f477debebc701545a8295a31dc589b9f40174a44a0c6e935ecab445c447078c3784
heap-coder
added a commit
to heap-coder/rust-miniscript
that referenced
this pull request
Sep 27, 2025
…tra-doc-links`
ebaa31bca7e80f02751e3435907b3aad99d74168 Enable usage of -D rustdoc::broken-intra-doc-links (Tobin C. Harding)
16b6c7629b3b8d6ca9c0fe016795d9ccb485ac96 Improve docs on enumerate_policy_tree (Tobin C. Harding)
90dc76664282e7632f02ab42e87a9cd7294e8398 Do trivial cleanup to main lib docs (Tobin C. Harding)
Pull request description:
Make an effort to do some docs improvements without touching the whole codebase.
- Patch 1: Trivial, because I can't help myself.
- Patch 2: Clean up docs on a private method in preparation for duplicating in public docs
- Patch 3: Fix broken links and enable `-D rustdoc::broken-intra-doc-links` in CI
I'm in no way across this codebase, there may be other problems with docs that show up in this PR but the PR is an attempt at improving the docs without going too wild - both for my sanity and that of reviewers.
ACKs for top commit:
apoelstra:
ACK ebaa31bca7e80f02751e3435907b3aad99d74168
Tree-SHA512: 6982f615fe6565f0defca30a4d4f4e077f9bcf446c1ed5f86cb15986c6b1d6f95a34cbd0d9b9c6096ccb932767aa71f99011931f612cc33c69709c79857679a0
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
2 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.
Make an effort to do some docs improvements without touching the whole codebase.
-D rustdoc::broken-intra-doc-linksin CII'm in no way across this codebase, there may be other problems with docs that show up in this PR but the PR is an attempt at improving the docs without going too wild - both for my sanity and that of reviewers.