mirror of
https://github.com/freemkv/libfreemkv.git
synced 2026-10-07 18:13:10 +00:00
Matthew Jackson
9f43ae94d3
- Cap every inline `//` comment block at 3 lines; distil the rationale rather than delete it. Enforced by a new comment-guard CI check. - Fix stale and orphaned rustdoc: broken intra-doc links (renamed or removed items), doc blocks that had merged onto the wrong item (leaving the intended item undocumented), and doc-contradicts-code drift. - Add a doc-links CI check (cargo doc, deny broken intra-doc links) so both classes of comment rot are caught going forward.
16 lines
433 B
YAML
16 lines
433 B
YAML
name: comment-guard
|
|
|
|
# Fails if any inline `//` comment block runs longer than 3 lines. Rustdoc
|
|
# (`///`, `//!`) is exempt. Keeps explanatory comments terse; long rationale
|
|
# belongs in a doc comment or a design note, not an inline wall.
|
|
|
|
on: [push, pull_request]
|
|
|
|
jobs:
|
|
comment-guard:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v7
|
|
- name: Run comment-guard
|
|
run: python3 ci/comment-guard.py
|