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

use -V (upper case) for --version short form #1720

Merged
merged 1 commit into from
Apr 24, 2023

Conversation

pmeier
Copy link
Member

@pmeier pmeier commented Apr 12, 2023

Reference Issues or PRs

Fixes #1719.

What does this implement/fix?

Put a x in the boxes that apply

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds a feature)
  • Breaking change (fix or feature that would cause existing features not to work as expected)
  • Documentation Update
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Build related changes
  • Other (please describe):

Testing

  • Did you test the pull request locally?
  • Did you add new tests?

Any other comments?

This could be considered BC breaking, but I feel that would be a tad too much.

@pavithraes pavithraes requested a review from iameskild April 21, 2023 14:35
nebari/cli/main.py Show resolved Hide resolved
@pavithraes
Copy link
Member

@iameskild @pmeier -- Would this be a breaking/surprising change for existing users? If so, maybe can have a deprecation warning or an error message for the lowercse -v as we change this behavior?

@pmeier
Copy link
Member Author

pmeier commented Apr 21, 2023

Would this be a breaking

Technically, yes.

surprising change for existing users

IMHO, no. As explained in #1719, with this change, our CLI is less surprising than before.

If so, maybe can have a deprecation warning or an error message for the lowercse -v as we change this behavior?

We could, but I wouldn't recommend it. For the reasons above and since we don't even have a BC policy as of now, I don't see the point. LMK if folks feel otherwise. Deprecation is not hard to implement here.

@iameskild iameskild merged commit 3937269 into nebari-dev:develop Apr 24, 2023
@pmeier pmeier deleted the version-shortform branch May 2, 2023 08:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

[ENH] - use -V instead of -v as shortform for --version
3 participants