swap order of completion instruction #1683
Merged
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.
The order was previously
source_{shell}
andcomplete_{shell}
because support for other shells was added later. In the new system the shell is always required, there is no longer the assumption of Bash if none is given. Since we've rewritten the system and all existing completion instructions and scripts are invalid anyway, take the opportunity to move the shell first. The order is now{shell}_source
and{shell}_complete
.One potential argument for the old order is that it could be used for autodetection. If the shell was left off the end, detect the shell. However, autodetection isn't particularly useful since the scripts and activation instruction differ between shells anyway. If we do want that later, being explicit with
auto_source
is fine too.related to #1484
Checklist:
CHANGES.rst
summarizing the change and linking to the issue... versionchanged::
entries in any relevant code docs.pre-commit
hooks and fix any issues.pytest
andtox
, no tests failed.