From 161546b11e08e7e28ab52c94c5b2af58572d2307 Mon Sep 17 00:00:00 2001 From: Mark Joshwel Date: Mon, 4 Sep 2023 16:49:45 +0000 Subject: [PATCH] docs: add constants introduced in by #20 to api ref --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 032533b..0901d28 100644 --- a/README.md +++ b/README.md @@ -557,13 +557,21 @@ line breakdown of shareable text output, accompanied by their Nominatim keys: a tuple of integers representing the version of surplus, in the format `[major, minor, patch]` +- `VERSION_SUFFIX: Final[str]` + `BUILD_BRANCH: Final[str]` + `BUILD_COMMIT: Final[str]` + `BUILD_DATETIME: Final[datetime]` + + string and a [datetime.datetime](https://docs.python.org/3/library/datetime.html) object + containing version and build information, set by [releaser.py](releaser.py) + - `SHAREABLE_TEXT_LINE_0_KEYS: tuple[str, ...]` `SHAREABLE_TEXT_LINE_1_KEYS: tuple[str, ...]` `SHAREABLE_TEXT_LINE_2_KEYS: tuple[str, ...]` `SHAREABLE_TEXT_LINE_3_KEYS: tuple[str, ...]` `SHAREABLE_TEXT_LINE_4_KEYS: tuple[str, ...]` `SHAREABLE_TEXT_LINE_5_KEYS: tuple[str, ...]` - `SHAREABLE_TEXT_LINE_6_KEYS: tuple[str, ...]` + `SHAREABLE_TEXT_LINE_6_KEYS: tuple[str, ...]` a tuple of strings containing nominatim keys used in shareable text line 0-6