Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

swap order of completion instruction #1683

Merged
merged 1 commit into from
Oct 7, 2020
Merged

swap order of completion instruction #1683

merged 1 commit into from
Oct 7, 2020

Conversation

davidism
Copy link
Member

@davidism davidism commented Oct 7, 2020

The order was previously source_{shell} and complete_{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:

  • Add tests that demonstrate the correct behavior of the change. Tests should fail without the change.
  • Add or update relevant docs, in the docs folder and in code.
  • Add an entry in CHANGES.rst summarizing the change and linking to the issue.
  • Add .. versionchanged:: entries in any relevant code docs.
  • Run pre-commit hooks and fix any issues.
  • Run pytest and tox, no tests failed.

@davidism davidism added the f:completion feature: shell completion label Oct 7, 2020
@davidism davidism added this to the 8.0.0 milestone Oct 7, 2020
@davidism davidism merged commit d15d0cd into master Oct 7, 2020
@davidism davidism deleted the complete-order branch October 7, 2020 13:46
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 13, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
f:completion feature: shell completion
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant