Skip to content

Deprecation notice now appears at the top of the help text#1816

Merged
davidism merged 1 commit into
pallets:masterfrom
BALaka-18:fix-deprecation-notice
Mar 31, 2021
Merged

Deprecation notice now appears at the top of the help text#1816
davidism merged 1 commit into
pallets:masterfrom
BALaka-18:fix-deprecation-notice

Conversation

@BALaka-18

Copy link
Copy Markdown
Contributor

This PR makes the deprecation notice appear at the beginning of the help text.

Checklist:

  • Add an entry in CHANGES.rst summarizing the change and linking to the issue.
  • Run pre-commit hooks and fix any issues.
  • Run pytest and tox, no tests failed.

Comment thread src/click/core.py Outdated
@davidism

Copy link
Copy Markdown
Member

This should update get_short_help_str as well.

@BALaka-18
BALaka-18 marked this pull request as draft March 26, 2021 18:40
@BALaka-18
BALaka-18 marked this pull request as ready for review March 28, 2021 22:33
Comment thread src/click/core.py Outdated
@davidism
davidism force-pushed the fix-deprecation-notice branch from 0010a05 to 77921aa Compare March 31, 2021 19:21
Co-authored-by: David Lord <davidism@gmail.com>
@davidism
davidism force-pushed the fix-deprecation-notice branch from 0fb55c5 to 0786fda Compare March 31, 2021 19:23
@davidism

Copy link
Copy Markdown
Member

Ended up doing some more refactoring to avoid some repetition. Added the deprecation notice when generating short help from help as well. Inlined the deprecation messages and made the notice title case.

@davidism davidism added this to the 8.0.0 milestone Mar 31, 2021
@davidism
davidism merged commit 08583da into pallets:master Mar 31, 2021
@github-actions github-actions Bot locked as resolved and limited conversation to collaborators Apr 15, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Deprecated notice in help text can be hard to see

2 participants