From db4074854a09f44e7ebc270f84fe2f43501e81e1 Mon Sep 17 00:00:00 2001 From: Nikolaus Schlemm <948118+nschlemm@users.noreply.github.com> Date: Sun, 19 Nov 2023 23:39:40 +0100 Subject: [PATCH] Fix documentation for UUID_FORMAT setting Looks like a simple copy-n-paste error ;) Keeping it consistent with code and tests in: * https://github.com/snok/django-guid/blob/main/django_guid/config.py#L67 * https://github.com/snok/django-guid/blob/main/django_guid/config.py#L86-L91 * https://github.com/snok/django-guid/blob/main/tests/functional/test_sync_middleware.py#L11-L24 * https://github.com/snok/django-guid/blob/main/tests/functional/test_sync_middleware.py#L45-L55 * https://github.com/snok/django-guid/blob/main/tests/functional/test_sync_middleware.py#L73-L83 * https://github.com/snok/django-guid/blob/main/tests/unit/test_config.py#L12-L13 * https://github.com/snok/django-guid/blob/main/tests/unit/test_config.py#L93-L120 * https://github.com/snok/django-guid/blob/main/tests/unit/test_uuid_length.py#L18-L24 --- docs/settings.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/settings.rst b/docs/settings.rst index 4c002d8..5393a39 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -83,11 +83,11 @@ If a full UUID hex is too long for you, this settings lets you specify the lengt The chance of collision in a UUID is so low, that most systems will get away with a lot fewer than 32 characters. -UUID_LENGTH +UUID_FORMAT ----------- * **Default**: ``hex`` * **Type**: ``string`` If a UUID hex is not suitable for you, this settings lets you specify the format you wish to use. The options are: * ``hex``: The default, a 32 character hexadecimal string. e.g. ee586b0fba3c44849d20e1548210c050 -* ``str``: A 36 character string. e.g. ee586b0f-ba3c-4484-9d20-e1548210c050 +* ``string``: A 36 character string. e.g. ee586b0f-ba3c-4484-9d20-e1548210c050