You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
xtask check-architecture-doc: guard against slash-containing prose false-failing CI #440
Follow-up from review on #432 (cargo xtask check-architecture-doc).
is_path_candidate (xtask/src/architecture_doc.rs) treats any backtick-quoted span containing / as a path citation unconditionally, with no guard against ordinary prose. Hyphenated bare words got an explicit guard against this exact failure mode (see the is_hyphenated_bare_word handling around architecture_doc.rs:574, protecting against e.g. `read-only` in prose), but nothing analogous exists for slash-containing prose.
So a future edit to docs/architecture.md containing backtick-quoted prose like `read/write`, `and/or`, or `GPU/CPU` would be misread as a path citation and false-fail CI, since none of those exist in the tracked tree.
Confirmed not currently live: docs/architecture.md doesn't contain this pattern today, so this isn't breaking anything yet — it's a latent trap for whoever edits the doc next.
Suggested fix
Extend is_path_candidate (or a helper it calls) with a guard analogous to is_hyphenated_bare_word, requiring path-shaped segments on both sides of / (e.g. each segment itself looking like a plausible path/file/directory component) before treating a slash-containing span as a citation, rather than accepting any slash unconditionally.
Add a regression test with common slash-joined prose phrases (read/write, and/or, GPU/CPU) confirming they're not treated as citations, alongside the existing real path/directory cases.
Reported independently by two reviewers on #432 (Copilot and juhovainio), both flagged non-blocking and suitable for a follow-up rather than expanding that PR further.
Activity
fix(xtask): harden path-candidate and clause-continuation checks
fix(xtask): abbreviation-aware sentence boundaries, directory/candida…
fix(xtask): abbreviation-aware sentence boundaries, directory/candida…
fix(xtask): harden path-candidate and clause-continuation checks
fix(xtask): abbreviation-aware sentence boundaries, directory/candida…
fix(xtask): harden path-candidate and clause-continuation checks
fix(xtask): abbreviation-aware sentence boundaries, directory/candida…
docs(architecture): rewrite citations as links, delete arch-doc checker
docs(architecture): rewrite citations as links, delete arch-doc checker
docs(architecture): rewrite citations as links, delete arch-doc checker
docs(architecture): rewrite citations as links, delete arch-doc checker
docs(architecture): rewrite citations as links, delete arch-doc checker
docs(architecture): rewrite citations as links, delete arch-doc check…