Skip to content

Commit

Permalink
Fix include_metadata typo to inherit_metadata and add documentati…
Browse files Browse the repository at this point in the history
…on note (#17)

- Corrected the typo from `include_metadata` to `inherit_metadata` in the documentation.
- Added a note to clarify the usage of `pdm lock` with dependency groups.
  • Loading branch information
tyong920 authored Jul 11, 2024
1 parent 3d35f10 commit 847ba10
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions doc/src/plugins/backend.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,12 @@ To set it up, a few configuration steps are required.
Lockfile configuration
======================

Your lockfile must be configured with the ``include_metadata`` strategy (``pdm>=2.11``) and include locks for the
optional-dependencies groups you want to publish locked.
Your lockfile must be configured with the ``inherit_metadata`` strategy (``pdm>=2.11``) and include locks for the optional-dependencies groups you want to publish locked.

.. note::
When running ``pdm lock``, ensure you select the appropriate dependency groups.

For instance, you can use ``pdm lock -G :all`` and then verify that the ``[metadata]`` section of the ``pdm.lock`` file includes the desired groups. For more details, refer to the ``Dependencies Selection:`` section in the ``pdm lock --help`` output.

buildsystem configuration
=========================
Expand Down

0 comments on commit 847ba10

Please sign in to comment.