Repository navigation
docs(backups): escape the pipes that split two residuals rows - #367
Merged
Merged
Conversation
GitHub's tables end a cell at an unescaped `|`, inside a code span too, so the `O_RDONLY|O_NONBLOCK` row and RC check 5's `head -c … | restic` row rendered with their columns shifted. `\|`, as the timeline row beside them already writes it.
earthlingdavey
added
documentation
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The inline-code flag expression in the numbered list contains an unnecessary pipe escape, causing an extra backslash to appear in the rendered documentation.
1 open issue
What changed in this PR
This documentation-only PR fixes pipe escaping in backup documentation so GitHub renders table columns correctly, without changing runtime behavior.
Changes:
- Escapes pipes in two accepted-residuals table rows.
- Escapes pipes in the package table and saved release-candidate results.
- Also adds an escape to a numbered-list code span.
| File | Description |
|---|---|
docs/design/backups/pr-plans/backups-rc-results.md |
Escapes the pipeline in the B2 listing table row. |
docs/design/backups/plan.md |
Adds flag-expression escapes in the package table and numbered list. |
backups/README.md |
Escapes flag and pipeline expressions in two residuals rows. |
Review effort: Balanced
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
In GitHub's tables an unescaped
|ends a cell even inside a code span. Four rows onbackuprendered with their columns shifted:backups/README.md, the accepted-residuals table:readRegularrow:O_RDONLY|O_NONBLOCK;head -c 8388608 /dev/urandom | restic ….docs/design/backups/plan.md, the package table'sdumprow:O_NOFOLLOW|O_NONBLOCK.docs/design/backups/pr-plans/backups-rc-results.md, the "B2 lists versions by name" row:| sort -k3,4.Each now writes
\|, as the residuals table's timeline row already does. No words change, so the design records still read as they did. A scan of every tracked.mdfile on the branch finds no other table row with an unescaped|inside a code span. Text only.Found while fixing #323. The last two rows came from the self-review.