summaryrefslogtreecommitdiff
path: root/docs/upgrading.rst
diff options
context:
space:
mode:
authorJ. Javier Maestro <jjmaestro@ieee.org>2019-02-04 23:14:03 +0000
committerDavid Lord <davidism@gmail.com>2020-02-22 14:13:00 -0800
commit588440b167ed95d1b76cd1083a9d512557aa1a4f (patch)
treea0caf385e43d1b3c621371238c69dd118e51a798 /docs/upgrading.rst
parent98a55ab1de06ee959d494d2b7ba11a5699921255 (diff)
downloadclick-588440b167ed95d1b76cd1083a9d512557aa1a4f.tar.gz
document command name replacing "_" with "-"
Diffstat (limited to 'docs/upgrading.rst')
-rw-r--r--docs/upgrading.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/upgrading.rst b/docs/upgrading.rst
index 7c4cccd..172ff13 100644
--- a/docs/upgrading.rst
+++ b/docs/upgrading.rst
@@ -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