Thanks to visit codestin.com
Credit goes to github.com

Skip to content

rustdoc: fix broken intra doc links #9097

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Nov 2, 2025
Merged

rustdoc: fix broken intra doc links #9097

merged 1 commit into from
Nov 2, 2025

Conversation

@cakebaker
Copy link
Contributor

@cakebaker cakebaker commented Oct 31, 2025 •
edited
Loading

This PR fixes some broken intra doc links. It should fix the following error shown by the CICD / Documentation/warnings job in the CI (see, for example, https://github.com/uutils/coreutils/actions/runs/18963810909/job/54156487338?pr=9094):

error: unresolved link to `Some(bytes)`
   --> src/uu/tail/src/chunks.rs:211:53
    |
211 |     /// [`UResult<None>`] or else the result with [`Some(bytes)`] where bytes is the number of bytes
    |                                                     ^^^^^^^^^^^ no item named `Some(bytes)` in scope
   |
    = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
    = note: `-D rustdoc::broken-intra-doc-links` implied by `-D warnings`
    = help: to override `-D warnings` add `#[allow(rustdoc::broken_intra_doc_links)]`

@cakebaker cakebaker marked this pull request as draft October 31, 2025 10:05
@codspeed-hq
Copy link

codspeed-hq bot commented Oct 31, 2025 •
edited
Loading

CodSpeed Performance Report

Merging #9097 will degrade performances by 31.87%

Comparing cakebaker:rustdoc_fix_link (6cb815e) with main (95b266f)

Summary

⚡ 16 improvements
❌ 16 regressions
✅ 93 untouched

⚠️ Please fix the performance issues or acknowledge them on CodSpeed.

Benchmarks breakdown

Benchmark BASE HEAD Change
❌ cp_large_file[16] 297.9 µs 339 µs -12.12%
❌ cp_recursive_deep_tree[(120, 4)] 13.3 ms 13.6 ms -2.77%
❌ du_deep_tree[(100, 3)] 1.1 ms 1.2 ms -2.61%
❌ expand_custom_tabstops[50000] 25.9 ms 36.6 ms -29.13%
❌ expand_many_lines[100000] 100.9 ms 148.1 ms -31.87%
⚡ fold_custom_width[50000] 46.6 ms 43.4 ms +7.54%
⚡ fold_many_lines[100000] 125.4 ms 116.2 ms +7.83%
❌ ls_recursive_deep_tree[(200, 2)] 2.1 ms 2.2 ms -2.38%
⚡ ls_recursive_long_all_balanced_tree[(6, 4, 15)] 139.8 ms 136.1 ms +2.69%
⚡ ls_recursive_long_all_mixed_tree 4 ms 2.8 ms +42.65%
⚡ ls_recursive_long_all_wide_tree[(15000, 1500)] 148.7 ms 142.5 ms +4.37%
❌ ls_recursive_mixed_tree 1.4 ms 1.4 ms -3.93%
❌ ls_recursive_wide_tree[(10000, 1000)] 51.4 ms 53 ms -3.16%
❌ mv_directory 3.1 ms 3.5 ms -9.86%
❌ mv_force_overwrite 121.8 ms 124.9 ms -2.46%
⚡ numfmt_large_numbers_si[10000] 34.5 ms 32.9 ms +4.66%
❌ numfmt_round_modes[("up", 10000)] 32.8 ms 34.7 ms -5.54%
⚡ seq_formatted 99.7 ms 97.2 ms +2.51%
⚡ seq_integers 26.7 ms 26.1 ms +2.15%
⚡ seq_with_step 13.6 ms 13.3 ms +2.12%
... ... ... ... ...

ℹ️ Only the first 20 benchmarks are displayed. Go to the app to view all benchmarks.

@cakebaker cakebaker changed the title tail: fix broken intra doc link csplit,tail: fix broken intra doc links Oct 31, 2025
@cakebaker cakebaker changed the title csplit,tail: fix broken intra doc links rustdoc: fix broken intra doc links Oct 31, 2025
@cakebaker cakebaker marked this pull request as ready for review October 31, 2025 10:40
@github-actions
Copy link

github-actions bot commented Oct 31, 2025

GNU testsuite comparison:

Skipping an intermittent issue tests/misc/tee (passes in this run but fails in the 'main' branch)

@cakebaker cakebaker requested a review from sylvestre October 31, 2025 12:51
@cakebaker cakebaker linked an issue Nov 1, 2025 that may be closed by this pull request
CICD: Documentation/warnings error: could not document uu_tail #9110
Closed
@cakebaker cakebaker mentioned this pull request Nov 1, 2025
Closed
@naoNao89 naoNao89 mentioned this pull request Nov 1, 2025
Merged
@sylvestre sylvestre merged commit 4f45042 into uutils:main Nov 2, 2025
120 of 122 checks passed
@cakebaker cakebaker deleted the rustdoc_fix_link branch November 2, 2025 13:05
naoNao89 pushed a commit to naoNao89/coreutils that referenced this pull request Nov 9, 2025
@cakebaker @naoNao89
Merge pull request uutils#9097 from cakebaker/rustdoc_fix_link
758057c 
rustdoc: fix broken intra doc links
@BrewTestBot BrewTestBot mentioned this pull request Nov 10, 2025
Merged
@moonfruit moonfruit mentioned this pull request Nov 10, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sylvestre sylvestre Awaiting requested review from sylvestre

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

CICD: Documentation/warnings error: could not document uu_tail

2 participants

@cakebaker @sylvestre