Skip to content

Commit

Permalink
Add note about new shell completion.
Browse files Browse the repository at this point in the history
  • Loading branch information
thedrow committed Sep 23, 2020
1 parent d505db6 commit 28231cb
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion docs/whatsnew-5.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ Make sure you are not affected by any of the important upgrade notes
mentioned in the :ref:`following section <v500-important>`.

You should mainly verify that any of the breaking changes in the CLI
do not affect you. Please refer to :ref:`New Command Line Interface` for details.
do not affect you. Please refer to :ref:`New Command Line Interface <new_command_line_interface>` for details.

Step 4: Migrate your code to Python 3
-------------------------------------
Expand Down Expand Up @@ -229,6 +229,8 @@ We apologize for the lack of notice in advance but we feel that the chance
you'll be affected by this breaking change is minimal which is why we
did it.

.. _new_command_line_interface:

New Command Line Interface
--------------------------

Expand All @@ -241,6 +243,13 @@ As a result a few breaking changes has been introduced:
sub command to start a shell. You can now invoke specific shell commands
without a shell. Type `celery amqp --help` or `celery shell --help` for details.

Click provides shell completion `out of the box <https://click.palletsprojects.com/en/7.x/bashcomplete/>`_.
This functionality replaces our previous bash completion script and adds
completion support for the zsh and fish shells.

The bash completion script was exported to `extras/celery.bash <https://github.com/celery/celery/blob/master/extra/bash-completion/celery.bash>`_
for the packager's convenience.

.. _v500-news:

News
Expand Down

0 comments on commit 28231cb

Please sign in to comment.