Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes documentation intra-links and enforce it #600

Merged
merged 3 commits into from May 3, 2021

Conversation

RCasatta
Copy link
Collaborator

@RCasatta RCasatta commented May 3, 2021

This fixes documentation intra-links so that are correctly rendered in generated HTML pages and on docs.rs

It also adds #![deny(broken_intra_doc_links)] and build docs in CI so that future errors of this kind are seen by the CI

Do we want to use nightly to build the docs since it's the version used on docs.rs?

Copy link
Contributor

@sgeisler sgeisler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

utACK c96f7ec

@dr-orlovsky dr-orlovsky added the minor API Change This PR should get a minor version bump label May 3, 2021
@dr-orlovsky dr-orlovsky added this to the 0.26.1 milestone May 3, 2021
Copy link
Collaborator

@dr-orlovsky dr-orlovsky left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

As a side note, from what I know, its common to use [`...`] notation for referencing types & fields, rather than simple [..]

Copy link
Member

@apoelstra apoelstra left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure

@apoelstra apoelstra merged commit 902e0ec into rust-bitcoin:master May 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
minor API Change This PR should get a minor version bump
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants