Repository navigation
Commit 5ea8e55
committed
docs: fix the four rustdoc link errors that fail
`ci / Docs` runs rustdoc with `-D warnings`; four link defects in `trash-core`
were errors under it, so `cargo doc` refused to document the crate (exit 101).
All four predate this branch — the job only started running here.
- windows.rs:34 and :141 — `[`Error`]` is ambiguous: the crate has both an
`Error` enum and thiserror's `Error` derive macro. Disambiguated to
`[`enum@Error`]`, rustdoc's own suggested form; both still link.
- windows.rs:94 — the `NameLengthTooLarge` doc linked `MAX_V2_NAME_CHARS`,
a crate-private const. Demoted to a code span and the value (32768) stated
inline, so a reader gets the cap without a link to something unreachable.
The const stays private.
- linux.rs:42 — `[8]` is a footnote reference to the trash-spec, but markdown
reads it as a reference link. Backticked.
No `#![allow(rustdoc::...)]` anywhere; no item's visibility changed.
Control (revert -> fail -> restore), same commit, same command
`RUSTDOCFLAGS="-D warnings" cargo doc --no-deps --workspace --all-features`:
with fix -> exit 0
fix reverted -> exit 101, 4 errors
restored -> exit 0
`cargo fmt --check` clean.
Only `ci / Docs` was in scope; no other check was touched.ci / Docs
1 parent 3fdac31 commit 5ea8e55
2 files changed
Lines changed: 5 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
39 | 39 | | |
40 | 40 | | |
41 | 41 | | |
42 | | - | |
| 42 | + | |
43 | 43 | | |
44 | 44 | | |
45 | 45 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
31 | 31 | | |
32 | 32 | | |
33 | 33 | | |
34 | | - | |
| 34 | + | |
35 | 35 | | |
36 | 36 | | |
37 | 37 | | |
| |||
91 | 91 | | |
92 | 92 | | |
93 | 93 | | |
94 | | - | |
| 94 | + | |
| 95 | + | |
95 | 96 | | |
96 | 97 | | |
97 | 98 | | |
| |||
138 | 139 | | |
139 | 140 | | |
140 | 141 | | |
141 | | - | |
| 142 | + | |
142 | 143 | | |
143 | 144 | | |
144 | 145 | | |
| |||
0 commit comments