Skip to content

Commit

Permalink
Merge pull request #1094 from maresb/version-scheme-docs
Browse files Browse the repository at this point in the history
Improve the docs about `version_scheme` and `local_scheme`
  • Loading branch information
RonnyPfannschmidt authored Jan 4, 2025
2 parents 3c145df + 3d8cefe commit 5d3a1f8
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,13 @@ Callables or other Python objects have to be passed in `setup.py` (via the `use_
: Relative path to the SCM root, defaults to `.` and is relative to the file path passed in `relative_to`

`version_scheme : str | Callable[[ScmVersion], str]`
: Configures how the local version number is constructed; either an entrypoint name or a callable.
: Configures how the version number is constructed; either an entrypoint name or a callable.
See [Version number construction](extending.md#setuptools_scmversion_scheme) for predefined implementations.

`local_scheme : str | Callable[[ScmVersion], str]`
: Configures how the local component of the version is constructed
: Configures how the local component of the version (the optional part after the `+`) is constructed;
either an entrypoint name or a callable.
See [Version number construction](extending.md#setuptools_scmlocal_scheme) for predefined implementations.


`version_file: Path | PathLike[str] | None = None`
Expand Down

0 comments on commit 5d3a1f8

Please sign in to comment.