rust-bitcoin / rust-bitcoin / 9420455631

83%

push

github

Merge rust-bitcoin/rust-bitcoin#2830: Fix Rustdocs warnings in `just check-api`

<a class=hub.com/rust-bitcoin/rust-bitcoin/commit/<a class="double-link" href="https://git"><a class=hub.com/rust-bitcoin/rust-bitcoin/commit/a09c3c5225113983184839316f15e70929fee42a">a09c3c522<a href="https://github.com/rust-bitcoin/rust-bitcoin/commit/f260b097f4cafd8151847a1b38fce86608e9c1f5"> Check API: remove false positives on rustdoc (Jose Storopoli)

Pull request description:

  Fixes the rustdocs build warnings.
  This PR is composed by two commits:

  - Updates `contrib/check-for-api-changes.sh` to ignore
    `rustdoc::broken_intra_doc_links` due to the features being turned on and off
    (see rationale below); and
  - Adds a `just doc` quick check that will check for all missing rustdoc broken links
    to counterbalance the allow flag above.

  As jyap808 has pointed out in #2800,
  we might not have a simple fix for these rustdoc build warnings inside the `just check-api`.
  This can be mitigated by adding a simple allow flag to `RUSTDOCFLAGS` in `contrib/check-for-api-changes.sh`.

  &gt; Took a quick look at this. Not sure if there&#39;s anything obvious to fix.
  &gt;
  &gt; A few warnings mentioning [`ordered::ArbitraryOrd`] which is only enabled when the &quot;--features ordered&quot; flag is used. No warning when the flag is enabled. Generated docs look OK.
  &gt;
  &gt; jyap808 in #2800

  Closes #2800.

  I don&#39;t know if this is the intended solution, or if we want to add more CI checks for the docs.
  Note that these docs checks are already covered in `rust-bitcoin/rust-bitcoin-maintainer-tools`: https://github.com/rust-bitcoin/rust-bitcoin-maintainer-tools/blob/<a class="double-link" href="https://github.com/rust-bitcoin/rust-bitcoin/commit/3494ceec521cbc2cbe7e4b0d3fb9219a2164f57d">3494ceec5</a>/ci/run_task.sh#L275-L278

  Any feedback will be appreciated.

ACKs for top commit:
  apoelstra:
    ACK a09c3c5225113983184839316f15e70929fee42a
  tcharding:
    ACK a09c3c5225113983184839316f15e70929fee42a

Tree-SHA512: d8a4a14a273bf6b600997522d5fd49bc2ce

19487 of 23403 relevant lines covered (83.27%)

16567.55 hits per line