Repository navigation
sync help, man page and reference with current behavior - #13
Merged
Merged
Conversation
- wrktr_use: parses the five session keys and never executes the config; a failed load keeps the previous session. The reference also claimed old-format configs are sourced, which has been untrue since 1.0.1. - wrktr_push (-u, force offer only after a rejection), wrktr_adopt (all remotes, uncommitted-changes warning), wrktr_reload (keeps the session, refuses a bad file), wrktr_git in dry-run (read-only commands run) and the offline fallback of wrktr_add/wrktr_checkout are now documented. - Man page: replace the placeholder clone URLs, keep the ./install.sh line from being dropped as a macro, and use a date mandoc can parse. Tests: guard tests for the help, man page and reference statements, a check for placeholder URLs in every doc, and a mandoc lint test. CI installs mandoc on Linux so that test runs there.
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.
Tests: guard tests for the help, man page and reference statements, a check for placeholder URLs in every doc, and a mandoc lint test. CI installs mandoc on Linux so that test runs there.
What and why
Changes
Checklist
All PRs
bats tests/passes locallyshellcheck worktree-functions.shpasses locallyCHANGELOG.mdupdated (add entry under[Unreleased])New public functions
[ "$1" = "--help" ] && { wrktr_help <name>; return 0; }guard presentwrktr_validate || return 1at top (for session-dependent functions)_wrktr_runwraps mutations;_wrktr_is_dryrungates conditional logic_wrktr_breaker red "..."(writes to stderr)wrktr_helpcase statementdocs/wrktr.mdfunction referencedocs/wrktr.mdtests/wrktr.bats(at least one success, one failure)Behavior changes to existing functions
docs/wrktr.mdupdated if command usage or behavior description changed