Skip to content

Type in config doc #966

Closed
Closed
@ljames8

Description

@ljames8

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions