Skip to content
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

Jump to bottom

Fix documentation for UUID_FORMAT setting #110

Merged
merged 1 commit into from Nov 20, 2023
Merged

Fix documentation for UUID_FORMAT setting #110

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/settings.rst
View file
Open in desktop
Expand Up @@ -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