wiki check
every reason the wiki is not fit to read
wiki check builds the site in a temporary folder and reports every problem it finds, without writing to
the wiki.[1] What each problem means is described on Checks, and how it runs on
every push on Continuous integration.
Usage
It takes only the options every command shares.[2]
wiki check [-h] [--root ROOT] [--wiki WIKI]
wiki check
Output
Each problem is printed to standard error as one sentence saying what is wrong and what to do; a problem with a sentence on a page also names that page and line.[3] Every claim marked as having no source is listed on standard output, and does not fail the check.[4] Then come every page's word count and citations, the totals, the budget warning while budgets are uncalibrated, and a last line counting pages and problems.[3] On a wiki of three pages with one uncited sentence:[3]
wiki: refunds.md:14: “A support agent can issue one.” states something and cites nothing; give it a reference, or {missing} if there is none
wiki: refunds.md:12: “Partial refunds are not offered. {missing}” is marked as having no source
wiki: goals 25 words 0 cited 0 missing
wiki: index 8 words 0 cited 0 missing
wiki: refunds 22 words 1 cited 1 missing
wiki: 1 source cited, 1 claim marked as having no source
wiki: the collected goals read in 17 words
wiki: these budgets are PROVISIONAL -- 500 words a page, 3500 for the collected goals. What this project's readers actually read has not been measured; until it is, the numbers are a guess that happens to be enforced. Set budget.calibrated in wiki.toml once it is.
wiki: 3 pages, 1 problem
Exit codes
| Code | Condition | Message |
|---|---|---|
0 |
no problem is found[5] | a last line ending 0 problems |
1 |
at least one problem is found[5] | each problem, then a last line such as wiki: 3 pages, 1 problem |
1 |
a problem stops the build | that problem alone[6] |
2 |
there is no wiki where it was pointed[5] | wiki: no wiki at nowhere |