Skip to content

Commit

Permalink
Explicit explanation of the breaking change in 7.0
Browse files Browse the repository at this point in the history
After the discussion in #1123 and seeing how this has bitten people (even if it can be expected because it's a major version and people should pin versions, etc) I think it would be nice to be explicit about such a change and list it in the "Upgrade" section.
  • Loading branch information
jjmaestro authored Feb 4, 2019
1 parent c16ff82 commit 7c1a141
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/upgrading.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ this is not entirely possible. In case we need to break backwards
compatibility this document gives you information about how to upgrade or
handle backwards compatibility properly.

.. _upgrade-to-7.0:

Upgrading to 7.0
----------------
Click 7.0 changed the default behaviour of subcommands. Subcommands that are named by the function now automatically have the underscore replaced with a dash. So now, if you register a function named `my_command` it becomes `my-command` in the command line interface by default. Thus, you can still use underscores by specifying the command names explicitly or use a `Command` subclass that doesn't have the new behavior.

.. _upgrade-to-3.2:

Upgrading to 3.2
Expand Down

0 comments on commit 7c1a141

Please sign in to comment.