resticprofile icon indicating copy to clipboard operation
resticprofile copied to clipboard

docs: clarify forget.keep- value 0 doesn't remove snapshots (#526)

Open hollowhemlock opened this issue 3 months ago โ€ข 2 comments

Addresses #526 . Clarifies meaning of 0.

hollowhemlock avatar Sep 06 '25 21:09 hollowhemlock

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 updates
restic/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 tweak
docs/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-sleep wording in docs/content/configuration/sleep.md for 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.

โค๏ธ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

coderabbitai[bot] avatar Sep 06 '25 21:09 coderabbitai[bot]

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.

creativeprojects avatar Sep 25 '25 19:09 creativeprojects