Files changed: - CHANGES.md - VERSION - kb/CONTRACT.md - tools/CONTRACT.md - tools/chemenu/commands/docs_verify.py - tools/chemenu/commands/git_publish.py - tools/chemenu/commands/lint.py - tools/chemenu/commands/xref.py - tools/chemenu/tests/test_cli.py
This commit is contained in:
1 parent
20745399c0
commit
8d5fc6e941
9 files changed
+54
-19
No files matched your search
+6
-4
@@ -132,10 +132,12 @@ decision record - is the instance's, in
|
||||
|
||||
## Quotation cap
|
||||
|
||||
At most 2 blockquoted lines per page. `wikitool lint` reports overages as advisory, since
|
||||
exceeding the cap can be a legitimate judgment call - but the page should carry the knowledge
|
||||
itself, not delegate it to quotations. The cap is about how much of the page you let quotes
|
||||
carry; it does not apply to text you are citing verbatim from a source.
|
||||
At most 2 blockquotes per page - a blockquote being a run of consecutive `>` lines, code masked
|
||||
out first, so a `>` inside a fenced shell transcript is a prompt rather than a quotation.
|
||||
`wikitool lint` reports overages as advisory, since exceeding the cap can be a legitimate
|
||||
judgment call - but the page should carry the knowledge itself, not delegate it to quotations.
|
||||
The cap is about how much of the page you let quotes carry, not how long a wrapped quotation
|
||||
runs; it does not apply to text you are citing verbatim from a source.
|
||||
|
||||
The register those lines are written in - what counts as a buzzword, what filler is refused -
|
||||
is the instance's, in [kb/CONVENTIONS.md § Tone](CONVENTIONS.md#tone).
|
||||
|
||||
Reference in new issue
Block a user