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.

Sign up for GitHub

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

Jump to bottom

Rename the CLI flags: Have same naming convention everywhere. --keep-presenting and -r #355

Closed
fohrloop opened this issue Jun 4, 2024 · 0 comments · Fixed by #356
Closed

Rename the CLI flags: Have same naming convention everywhere. --keep-presenting and -r #355

fohrloop opened this issue Jun 4, 2024 · 0 comments · Fixed by #356

Comments

@fohrloop
Copy link
Owner

fohrloop commented Jun 4, 2024

The wakepy Modes are keep.running and keep.presenting. The CLI options are:

  • -k, --keep-running
  • -p, --presentation

Why to use different name for the mode in the CLI? For consisency, would be better that the option would be:

  • -r, --keep-running
  • -p, --keep-presenting

This is a breaking change so it needs a deprecation notice. Can't put deprecation notice on a patch release, so probably could aim for wakepy 0.10.0 for deprecation and next non-patch release for the change.
@fohrloop fohrloop mentioned this issue Jun 4, 2024
Merged
@fohrloop fohrloop mentioned this issue Sep 19, 2024
Merged
fohrloop added a commit that referenced this issue Sep 19, 2024
@fohrloop
Rename the CLI flags: Addendum to PR 356 (#391)
eefc7ce 
Amends: #356
Relates to issue: #355

- Update CLI API docs
- Use print() instead of DeprecationWarning, as DeprecationWarnings are
  not printed to standard output by default.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

new CLI flags fohrloop/wakepy
1 participant
@fohrloop