Skip to content

Commit

Permalink
📚 [README] Explain distribution_format as keyword-only string param…
Browse files Browse the repository at this point in the history
…eter (#517)

Fixes #250
  • Loading branch information
cjolowicz authored Nov 12, 2021
1 parent 5a9b39d commit c2e71b8
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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?
----
Expand Down Expand Up @@ -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/
Expand Down

0 comments on commit c2e71b8

Please sign in to comment.