Clarify docs for --dir option #2123
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
andreynering
approved these changes
Apr 17, 2025
Member
andreynering
left a comment
andreynering
left a comment
There was a problem hiding this comment.
Hi @jberkenbilt!
Thanks for contributing.
I made a change to the wording because Task will also execute in that directory, as well as look for Taskfiles there.
Contributor
Author
|
Thanks! I guess I didn't quite accurately figure out what it was doing, but the new doc is clear. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
See #2102. I think the actual behavior of
--diris useful and described correctly in the Getting Started section of the documentation, but the help and CLI reference don't explain it correctly.The docs and help describe it as setting the working directory, but what it actually seems to do is to set the directory from which to start searching for a Taskfile. This is useful for running utility-like Taskfiles and seems like a useful feature that is distinct from setting the work directory. This PR just changes the docs to match the behavior. I'm not sure whether the behavior is wrong, but changing behavior would be non-compatible. Looking through the tests, I think the tool is behaving as intended, but the docs are misleading.
I just started playing with
tasktoday. If you agree with this but want to word it differently or update more docs or change tests, etc., you can discard this and do it a different way.