fix(cli): correct --roster help text to state true default resolution order (#102) - #104
Open
ghzhost wants to merge 1 commit into
Open
fix(cli): correct --roster help text to state true default resolution order (#102)#104ghzhost wants to merge 1 commit into
ghzhost wants to merge 1 commit into
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.
Problem
tanglebrain --helpstated that the default--rosterpath istanglebrain/config/roster.yaml. In practice,default_roster_path()resolves:$TANGLEBRAIN_ROSTERenvironment variable$XDG_CONFIG_HOME/tanglebrain/roster.yaml(or~/.config/tanglebrain/roster.yaml) if it existstanglebrain/config/roster.yaml)Misstating this default in
--helpleads operators debugging routing to look at and edit the wrong file.Changes
--rosterhelp text intanglebrain/cli.pyto describe the actual resolution order ($TANGLEBRAIN_ROSTER,~/.config/tanglebrain/roster.yaml, or packaged example).test_roster_help_text_states_discovery_orderintests/test_cli.py.CHANGELOG.mdunder[Unreleased]->Fixed.Closes #102