mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-03 00:23:06 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

crypt docs: Fix references to methods attr (GH-26806)

Browse source 
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
This commit is contained in:
andrei kulakov 2022-04-04 22:50:13 -04:00 • committed by GitHub
parent 43571a3eea
commit cae0f5d3da
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

7
Doc/library/crypt.rst
View file

@ -96,8 +96,7 @@ The :mod:`crypt` module defines the following functions:
:func:`mksalt`, one of the ``crypt.METHOD_*`` values (though not all :func:`mksalt`, one of the ``crypt.METHOD_*`` values (though not all
may be available on all platforms), or a full encrypted password may be available on all platforms), or a full encrypted password
including salt, as returned by this function. If *salt* is not including salt, as returned by this function. If *salt* is not
provided, the strongest method will be used (as returned by provided, the strongest method available in :attr:`methods` will be used.
:func:`methods`).
Checking a password is usually done by passing the plain-text password Checking a password is usually done by passing the plain-text password
as *word* and the full results of a previous :func:`crypt` call, as *word* and the full results of a previous :func:`crypt` call,
@ -125,8 +124,8 @@ The :mod:`crypt` module defines the following functions:
.. function:: mksalt(method=None, *, rounds=None) .. function:: mksalt(method=None, *, rounds=None)
Return a randomly generated salt of the specified method. If no Return a randomly generated salt of the specified method. If no
*method* is given, the strongest method available as returned by *method* is given, the strongest method available in :attr:`methods` is
:func:`methods` is used. used.
The return value is a string suitable for passing as the *salt* argument The return value is a string suitable for passing as the *salt* argument
to :func:`crypt`. to :func:`crypt`.