Skip to content

Commit

Permalink
Document default constants
Browse files Browse the repository at this point in the history
  • Loading branch information
hynek committed Dec 30, 2015
1 parent e43c82c commit 654bec1
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,19 @@ But of course the :class:`PasswordHasher` class has all the parametrization you'
.. autoclass:: PasswordHasher
:members: hash, verify

If you don't specify any parameters, the following constants are used:

.. data:: DEFAULT_RANDOM_SALT_LENGTH
.. data:: DEFAULT_HASH_LENGTH
.. data:: DEFAULT_TIME_COST
.. data:: DEFAULT_MEMORY_COST
.. data:: DEFAULT_PARALLELISM

You can see their values in :class:`PasswordHasher`.


Exceptions
^^^^^^^^^^

.. autoexception:: argon2.exceptions.VerificationError

Expand Down

0 comments on commit 654bec1

Please sign in to comment.