Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update usedevelop doc by referring to PEP-660. #3025

Merged
merged 3 commits into from
Jun 6, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions docs/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -594,8 +594,17 @@ Python run
:default: false
:version_added: 1.6

Install the current package in development mode with develop mode. For pip this uses ``-e`` option, so should be
avoided if you've specified a custom :ref:`install_command` that does not support ``-e``.
Install the current package in development mode using :pep:`660`. This means that the package will
be installed in-place and editable.

.. note::

``package = editable`` is the preferred way to enable development/editable mode. See the details in :ref:`package`.

.. note::

PEP-660 introduced a standardized way of installing a package in development mode, providing the same effect as if
``pip install -e`` was used.

.. conf::
:keys: package
Expand Down