From d2ac66c0e3ba0b8d30d06f1bd739135e5a57c3e7 Mon Sep 17 00:00:00 2001 From: Claudio Jolowicz Date: Tue, 17 May 2022 13:34:54 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9A=20[reference]=20Fix=20broken=20cro?= =?UTF-8?q?ss-references=20to=20Poetry=20documentation=20(#738)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/nox_poetry/sessions.py | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/src/nox_poetry/sessions.py b/src/nox_poetry/sessions.py index 4fc85974..9d451147 100644 --- a/src/nox_poetry/sessions.py +++ b/src/nox_poetry/sessions.py @@ -199,17 +199,15 @@ def installroot( def export_requirements(self) -> Path: """Export a requirements file from Poetry. - This function uses `poetry export`_ to generate a :ref:`requirements - file ` containing the project dependencies at the - versions specified in ``poetry.lock``. The requirements file includes - both core and development dependencies. + This function uses `poetry export `_ + to generate a :ref:`requirements file ` containing the + project dependencies at the versions specified in ``poetry.lock``. The + requirements file includes both core and development dependencies. The requirements file is stored in a per-session temporary directory, together with a hash digest over ``poetry.lock`` to avoid generating the file when the dependencies have not changed since the last run. - .. _poetry export: https://python-poetry.org/docs/cli/#export - Returns: The path to the requirements file. """ @@ -237,11 +235,10 @@ def build_package( ) -> str: """Build a distribution archive for the package. - This function uses `poetry build`_ to build a wheel or sdist archive for - the local package, as specified via the ``distribution_format`` parameter. - It returns a file URL with the absolute path to the built archive. - - .. _poetry build: https://python-poetry.org/docs/cli/#export + This function uses `poetry build `_ + to build a wheel or sdist archive for the local package, as specified via the + ``distribution_format`` parameter. It returns a file URL with the absolute path + to the built archive. Args: distribution_format: The distribution format, either wheel or sdist.