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

Implement to show the message with --help #2271

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

peacock0803sz
Copy link

Implement of #2263, Showing deprecation message with --help for @click.option

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.

@peacock0803sz peacock0803sz marked this pull request as ready for review May 2, 2022 23:25
@saroad2
Copy link
Collaborator

saroad2 commented May 7, 2023

Hello @peacock0803sz , thanks for the PR and sorry for the long delay.

This seems fine to me, and very helpful for user to use click in a backward compatible way.

However, this PR lacks a very important compnant: Once someone does use a deprecated option, a warning should be printed. This is done today with deprecated commands. You can look here for inspiration.

Please fix this issue before I review this PR again.

@davidism davidism added this to the 8.2.0 milestone Jun 30, 2023
@AndreasBackx AndreasBackx mentioned this pull request Oct 20, 2024
35 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Mark parameter as deprecated
3 participants