docs: clarify forget.keep- value 0 doesn't remove snapshots (#526)
Addresses #526 . Clarifies meaning of 0.
Walkthrough
Updated help text in restic/commands.json for six forget options to clarify default value behaviour and add a docs link; adjusted wording in docs/content/configuration/sleep.md to specify that prevent-sleep applies while running commands. No behavioural or API changes.
Changes
| Cohort / File(s) | Summary of Changes |
|---|---|
Option description updatesrestic/commands.json |
Amended description text for forget options keep-daily, keep-hourly, keep-last, keep-monthly, keep-weekly, keep-yearly to note that the default value of 0 removes no snapshots and to add a documentation link. |
Documentation wording tweakdocs/content/configuration/sleep.md |
Clarified that prevent-sleep applies "while running commands" rather than generally; no other content changes. |
Estimated code review effort
๐ฏ 1 (Trivial) | โฑ๏ธ ~3 minutes
Areas to spot-check:
- The updated sentences for accuracy and grammar in
restic/commands.json. - The
prevent-sleepwording indocs/content/configuration/sleep.mdfor contextual consistency with surrounding documentation.
Pre-merge checks and finishing touches
โ Passed checks (3 passed)
| Check name | Status | Explanation |
|---|---|---|
| Title check | โ Passed | The title accurately describes the main change: clarifying that forget command options with value 0 don't remove snapshots, with a reference to issue #526. |
| Description check | โ Passed | The description is related to the changeset, referencing issue #526 and indicating the change clarifies the meaning of value 0 for forget options. |
| Docstring Coverage | โ Passed | No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. |
โจ Finishing touches
๐งช Generate unit tests (beta)
- [ ] Create PR with unit tests
- [ ] Post copyable unit tests in a comment
๐ Recent review details
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
๐ฅ Commits
Reviewing files that changed from the base of the PR and between 1159ec1dcb3f0331ea14db42cb434be10673b0c2 and 7d72c1230ddd107bff9cde3d06d286558123d9dd.
๐ Files selected for processing (1)
docs/content/configuration/sleep.md(1 hunks)
โ Files skipped from review due to trivial changes (1)
- docs/content/configuration/sleep.md
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Comment @coderabbitai help to get the list of available commands and usage tips.
Hey! Thank you for the clarification.
This file commands.json is actually generated from the restic documentation itself (after running restic generate --man).
It's going to be a bit move involved to add this message: in the documentation parser, we need to add it to the existing description from the manual.