Conversation
|
To fix the formatting issues:
Alternatively, a maintainer can comment /fmt in this PR to auto-apply fixes in a new commit from the bot. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| ### `rolling_file` | ||
|
|
There was a problem hiding this comment.
[HIGH] Appender heading uses code styling
The rolling_file appender heading currently uses inline code formatting (backticks) in the H3 line (### \rolling_file`). The style guide states that headings should not use code styling except for narrow exceptions that do not apply here. Leaving code formatting in this heading harms consistency and reduces readability in generated tables of contents. Similar appender headings in the same document follow this pattern and should be adjusted consistently, but this finding’s primary location is scoped to the rolling_file` heading.
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
| | `overlay` | Overlay networks | | ||
| | `overlay_broadcast` | Overlay broadcast messages | | ||
| | `rldp` | RLDP protocol (reliable large datagrams) | | ||
| | `dht` | Distributed Hash Table | |
There was a problem hiding this comment.
[HIGH] Generic concept capitalized mid-sentence
In the logger targets table, the description for dht is written as “Distributed Hash Table”, capitalizing “Hash” and “Table” within a sentence. The style guide requires generic technical concepts to remain lowercase mid-sentence (for example, “smart contract” instead of “Smart Contract”). Keeping this term fully capitalized makes casing inconsistent across the documentation. Lowercasing the generic words while preserving the acronym in the first column restores consistency with the style rules.
| | `dht` | Distributed Hash Table | | |
| | `dht` | Distributed hash table | |
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
1 participant
closes #1818