random_string: add docs to use min_* (#10610)
Some checks are pending
EOL CI / EOL Sanity (Ⓐ2.16) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.16+py2.7) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.16+py3.11) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.16+py3.6) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/3/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/3/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/3/) (push) Waiting to run
nox / Run extra sanity tests (push) Waiting to run

* random_string: add docs to use min_*

* Update docs for min_* usage

Fixes: #10576

Signed-off-by: Abhijeet Kasurde <Akasurde@redhat.com>

* Review requests

Signed-off-by: Abhijeet Kasurde <Akasurde@redhat.com>

---------

Signed-off-by: Abhijeet Kasurde <Akasurde@redhat.com>
This commit is contained in:
Abhijeet Kasurde 2025-08-06 11:44:26 -07:00 committed by GitHub
commit 9155bc2e53
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -25,26 +25,30 @@ options:
type: int
upper:
description:
- Include uppercase letters in the string.
- Possibly include uppercase letters in the string.
- To ensure atleast one uppercase letter, set O(min_upper) to V(1).
default: true
type: bool
lower:
description:
- Include lowercase letters in the string.
- Possibly include lowercase letters in the string.
- To ensure atleast one lowercase letter, set O(min_lower) to V(1).
default: true
type: bool
numbers:
description:
- Include numbers in the string.
- Possibly include numbers in the string.
- To ensure atleast one numeric character, set O(min_numeric) to V(1).
default: true
type: bool
special:
description:
- Include special characters in the string.
- Possibly include special characters in the string.
- Special characters are taken from Python standard library C(string). See L(the documentation of
string.punctuation,https://docs.python.org/3/library/string.html#string.punctuation)
for which characters are used.
- The choice of special characters can be changed to setting O(override_special).
- To ensure atleast one special character, set O(min_special) to V(1).
default: true
type: bool
min_numeric: