From c2e71b8ff5095de8eb82212d7a93919d707e25fd Mon Sep 17 00:00:00 2001 From: Claudio Jolowicz Date: Fri, 12 Nov 2021 13:29:00 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9A=20[README]=20Explain=20`distributi?= =?UTF-8?q?on=5Fformat`=20as=20keyword-only=20string=20parameter=20(#517)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Fixes #250 --- README.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index e745af1d..adedecea 100644 --- a/README.rst +++ b/README.rst @@ -89,10 +89,12 @@ Behind the scenes, nox-poetry uses Poetry to export a `constraints file`_ and bu For more fine-grained control, additional utilities are available under the ``session.poetry`` attribute: -- ``session.poetry.installroot(distribution_format=[WHEEL|SDIST])`` -- ``session.poetry.build_package(distribution_format=[WHEEL|SDIST])`` +- ``session.poetry.installroot(distribution_format=["wheel"|"sdist"])`` +- ``session.poetry.build_package(distribution_format=["wheel"|"sdist"])`` - ``session.poetry.export_requirements()`` +Note that ``distribution_format`` is a `keyword-only parameter`_. + Why? ---- @@ -188,6 +190,7 @@ This project was generated from `@cjolowicz`_'s `Hypermodern Python Cookiecutter .. _Poetry: https://python-poetry.org/ .. _constraints file: https://pip.pypa.io/en/stable/user_guide/#constraints-files .. _file an issue: https://github.com/cjolowicz/nox-poetry/issues +.. _keyword-only parameter: https://docs.python.org/3/glossary.html#keyword-only-parameter .. _nox.sessions.Session.install: https://nox.thea.codes/en/stable/config.html#nox.sessions.Session.install .. _nox.sessions.Session.run: https://nox.thea.codes/en/stable/config.html#nox.sessions.Session.run .. _pip install: https://pip.pypa.io/en/stable/reference/pip_install/