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 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -594,8 +594,8 @@ 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 <https://peps.python.org/pep-0660/>`. This means that the
package will be installed in-place and editable. (Note that this has the same effect as the `pip install -e` command.)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add a note, that setting package = editable is preferred over using this?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Of course, it is done now. I have also clarified the PEP-660 and -e connection in a separated note.


.. conf::
:keys: package
Expand Down