Skip to content

Commit 5d3a1f8

Browse files
Merge pull request #1094 from maresb/version-scheme-docs
Improve the docs about `version_scheme` and `local_scheme`
2 parents 3c145df + 3d8cefe commit 5d3a1f8

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/config.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,13 @@ Callables or other Python objects have to be passed in `setup.py` (via the `use_
1111
: Relative path to the SCM root, defaults to `.` and is relative to the file path passed in `relative_to`
1212

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

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

2022

2123
`version_file: Path | PathLike[str] | None = None`

0 commit comments

Comments
 (0)