docs: clarify reflog recovery boundaries#23
Merged
Conversation
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
1 participant
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.
Summary
Tightens the public-facing copy so git-time-machine is described as a visual reflog browser for reachable local history, not a universal Git undo tool. The README now includes explicit recovery boundaries, the CLI/crate/landing-page descriptions avoid overbroad claims, and the documented controls/features match the current
0.3.0behavior.This also updates the changelog for
0.3.0and applies rustfmt plus two small clippy cleanups while touching the CLI help text.Verification
cargo fmt --checkcargo clippy -- -D warningscargo testcargo buildgit diff --check