Skip to content

Increase docs clarity#419

Draft
forsyth2 wants to merge 3 commits intomainfrom
increase-docs-clarity
Draft

Increase docs clarity#419
forsyth2 wants to merge 3 commits intomainfrom
increase-docs-clarity

Conversation

@forsyth2
Copy link
Collaborator

@forsyth2 forsyth2 commented Jan 7, 2026

Summary

Objectives:

  • Add tests confirming expected behavior in various tar workflows (originally Add test of tar workflows #418).
  • Update documentation (based on scenarios unit/integration tested) to answer FAQ about zstash behavior.

Issue resolution:

Select one: This pull request is...

  • a bug fix: increment the patch version
  • a small improvement: increment the minor version
  • a new feature: increment the minor version
  • an incompatible (non-backwards compatible) API change: increment the major version

Small Change

  • To merge, I will use "Squash and merge". That is, this change should be a single commit.
  • Logic: I have visually inspected the entire pull request myself.
  • Pre-commit checks: All the pre-commits checks have passed.

@forsyth2 forsyth2 self-assigned this Jan 7, 2026
@forsyth2 forsyth2 added Testing Files in `tests` modified Documentation Files in `docs` modified labels Jan 7, 2026
@forsyth2 forsyth2 mentioned this pull request Jan 7, 2026
7 tasks
@forsyth2
Copy link
Collaborator Author

forsyth2 commented Jan 7, 2026

Commit 3 addresses the user question in #401 as well.

@forsyth2
Copy link
Collaborator Author

forsyth2 commented Jan 7, 2026

Action items:

  • Visually inspect test/doc changes and evaluate their accuracy.
  • Code review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Files in `docs` modified Testing Files in `tests` modified

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant