Skip to content

Type in config doc #966

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.

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

Closed
ljames8 opened this issue Oct 26, 2023 · 0 comments · Fixed by #996
Closed

Type in config doc #966

ljames8 opened this issue Oct 26, 2023 · 0 comments · Fixed by #996

Comments

@ljames8
Copy link

ljames8 commented Oct 26, 2023

Hi

Looks like there is a typo with version_file_template in the config.md.
Also the doc does not mention the version_tuple keyword argument. How about something like this ?

diff --git a/docs/config.md b/docs/config.md
index 0acdf6f..f187ae4 100644
--- a/docs/config.md
+++ b/docs/config.md
@@ -29,9 +29,9 @@ Callables or other Python objects have to be passed in `setup.py` (via the `use_
         Only files with `.py` and `.txt` extensions have builtin templates,
         for other file types it is necessary to provide `write_to_template`.

-`version_file_template_template: str | None = None`
+`version_file_template: str | None = None`
 :   A new-style format string that is given the current version as
-    the `version` keyword argument for formatting.
+    the `version` and `version_tuple` keyword arguments for formatting.

 `write_to: Pathlike[str] | Path | None = None`
 :  (deprecated) legacy option to create a version file relative to the scm root
RonnyPfannschmidt added a commit to RonnyPfannschmidt/setuptools_scm that referenced this issue Jan 8, 2024
RonnyPfannschmidt added a commit to RonnyPfannschmidt/setuptools_scm that referenced this issue Feb 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant