click icon indicating copy to clipboard operation
click copied to clipboard

Implement to show the message with `--help`

Open peacock0803sz opened this issue 2 years ago • 1 comments

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

  • fixes #2263

Checklist:

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

peacock0803sz avatar May 02 '22 21:05 peacock0803sz

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.

saroad2 avatar May 07 '23 02:05 saroad2