Skip to content

Improve the docs about version_scheme and local_scheme #1094

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 4, 2025
Merged

Improve the docs about version_scheme and local_scheme #1094

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
327b428
Add cross-reference from version_scheme config to implementations
maresb Jan 3, 2025
c633987
Remove the word "local" per PEP 440
maresb Jan 3, 2025
34a89a9
Clarify the definition of "local"
maresb Jan 3, 2025
3d8cefe
Add cross-reference from local_scheme config to implementations
maresb Jan 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/config.md
View file
Open in desktop
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
Loading