Skip to content

Commit

Permalink
Develop (#926)
Browse files Browse the repository at this point in the history
* Fix code duplication in docs

* Add version testing for Cryptographic.uuid

* Fix #918

* Change version in __init__.py

* Fix bug with not unique uuids

* Update changelog

* Add watning to docstrings
  • Loading branch information
lk-geimfari committed Aug 22, 2020
1 parent ab61b22 commit 42444a2
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 4 deletions.
7 changes: 3 additions & 4 deletions CHANGELOG.rst
Expand Up @@ -17,8 +17,8 @@ Version 4.1.0

**Updated**:

- Update parameter ``end`` for some methods of provider ``Datetime()`` (Fix #870)
- Update ``.price()`` to make it supported locales (Fix #875)
- Updated parameter ``end`` for some methods of provider ``Datetime()`` (Fix #870)
- Updated ``.price()`` to make it supported locales (Fix #875)

**Rename**:

Expand Down Expand Up @@ -58,8 +58,7 @@ Version 4.0.0
**Updated**:

- Updated names and surnames for locale ``ru``
- The ``floats()`` function in the ``Numbers`` provider now accepts arguments about the range of the generated float
numbers and the rounding used. By default, it generates a list of ``n`` float numbers insted of a list of 10^n elements.
- The ``floats()`` function in the ``Numbers`` provider now accepts arguments about the range of the generated float numbers and the rounding used. By default, it generates a list of ``n`` float numbers instead of a list of 10^n elements.
- The argument ``length`` of the function ``integers`` is renamed to ``n``.

**Removed**:
Expand Down
6 changes: 6 additions & 0 deletions mimesis/providers/cryptographic.py
Expand Up @@ -38,6 +38,9 @@ def uuid(as_object: bool = False) -> Union[UUID, str]:
but you can make it return uuid.UUID object using
parameter **as_object**
.. warning:: Seed is not applicable to this method,
because of its cryptographic-safe nature.
:param as_object: Returns uuid.UUID.
:return: UUID.
"""
Expand All @@ -54,6 +57,9 @@ def hash(self, algorithm: Algorithm = None) -> str: # noqa: A003
To change hashing algorithm, pass parameter ``algorithm``
with needed value of the enum object :class:`~mimesis.enums.Algorithm`
.. warning:: Seed is not applicable to this method,
because of its cryptographic-safe nature.
:param algorithm: Enum object :class:`~mimesis.enums.Algorithm`.
:return: Hash.
:raises NonEnumerableError: When algorithm is unsupported.
Expand Down

0 comments on commit 42444a2

Please sign in to comment.