Repository navigation
Commit 3dcd2f3
committed
docs(docs): fifth whole-repo pass over the non-API docs, with issue/PR roles (#1103)
- Cite issues and pull requests by :issue:/:pr: in rendered text: the
hand-written GitHub links in workflows.rst, releasing.rst and pep.rst,
the bare #NNN in workflows.rst, and the #NNN in pcapkit docstrings and
#: comments. #2050, linked as an issue, is a pull request.
- Add tests/project/test_docs_issue_pr_roles_1103_unit.py, which fails on
a hand-written link or bare #NNN in .rst pages, docstrings and #:
comments; its allowlist holds only the references other tests pin.
- Record the rule on the documentation conventions page.
- Name the external action functions releasing.rst and workflows.rst cited
by line, where no test pins the line.
- Fix stale claims: the shared changelog pull request has merged, the
Windows leg runs leg_summary.py and pip_install.py, Lint expects pylint's
import-error rather than tracking a count, pypcapfile fails from 3.12 up
rather than working only on 3.10 and 3.11, cryptography in the all extra
is no pure-Python wheel; drop "today", "this change" and "current".
Docs build: no warnings, and the same 116 under -n as origin/main.1 parent 4c3d301 commit 3dcd2f3
19 files changed
Lines changed: 493 additions & 183 deletions
File tree
- docs/source
- contributing
- conventions
- pcapkit
- dumpkit
- foundation/engines
- protocols/schema/misc
- toolkit
- tests/project
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
314 | 314 | | |
315 | 315 | | |
316 | 316 | | |
| 317 | + | |
| 318 | + | |
| 319 | + | |
| 320 | + | |
| 321 | + | |
| 322 | + | |
| 323 | + | |
| 324 | + | |
| 325 | + | |
| 326 | + | |
| 327 | + | |
317 | 328 | | |
318 | 329 | | |
319 | 330 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
65 | 65 | | |
66 | 66 | | |
67 | 67 | | |
68 | | - | |
| 68 | + | |
69 | 69 | | |
70 | 70 | | |
71 | 71 | | |
| |||
88 | 88 | | |
89 | 89 | | |
90 | 90 | | |
91 | | - | |
| 91 | + | |
92 | 92 | | |
93 | | - | |
| 93 | + | |
94 | 94 | | |
95 | 95 | | |
96 | 96 | | |
| |||
142 | 142 | | |
143 | 143 | | |
144 | 144 | | |
145 | | - | |
146 | | - | |
147 | | - | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
148 | 148 | | |
149 | 149 | | |
150 | 150 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
360 | 360 | | |
361 | 361 | | |
362 | 362 | | |
363 | | - | |
| 363 | + | |
364 | 364 | | |
365 | 365 | | |
366 | 366 | | |
| |||
506 | 506 | | |
507 | 507 | | |
508 | 508 | | |
509 | | - | |
510 | | - | |
| 509 | + | |
| 510 | + | |
511 | 511 | | |
512 | 512 | | |
513 | 513 | | |
| |||
1116 | 1116 | | |
1117 | 1117 | | |
1118 | 1118 | | |
1119 | | - | |
| 1119 | + | |
1120 | 1120 | | |
1121 | 1121 | | |
1122 | 1122 | | |
| |||
1129 | 1129 | | |
1130 | 1130 | | |
1131 | 1131 | | |
1132 | | - | |
| 1132 | + | |
1133 | 1133 | | |
1134 | 1134 | | |
1135 | 1135 | | |
1136 | 1136 | | |
1137 | 1137 | | |
1138 | | - | |
| 1138 | + | |
1139 | 1139 | | |
1140 | 1140 | | |
1141 | 1141 | | |
| |||
0 commit comments