diff options
| author | Eli Collins <elic@assurancetechnologies.com> | 2012-01-02 14:19:38 -0500 |
|---|---|---|
| committer | Eli Collins <elic@assurancetechnologies.com> | 2012-01-02 14:19:38 -0500 |
| commit | 3b56bcca1021a069507e37caa9f74aceba8e1dd7 (patch) | |
| tree | 325f59ca94563001293db4e5a70562677798bab8 /docs | |
| parent | f80685ffefcb1c0ab29f543039fd0707bcf7342e (diff) | |
| download | passlib-3b56bcca1021a069507e37caa9f74aceba8e1dd7.tar.gz | |
minor doc changes
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/lib/passlib.context-options.rst | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/docs/lib/passlib.context-options.rst b/docs/lib/passlib.context-options.rst index 9753e39..745e7cf 100644 --- a/docs/lib/passlib.context-options.rst +++ b/docs/lib/passlib.context-options.rst @@ -98,21 +98,20 @@ Within INI files, this may be specified using the alternate format :samp:`{hash} Sets the default number of rounds to use when generating new hashes (via :meth:`CryptContext.encrypt`). - If not set, this will use max rounds hash option (see below), - or fall back to the algorithm-specified default. + If not set, this will use an algorithm-specific default. For hashes which do not support a rounds parameter, this option is ignored. :samp:`{hash}__vary_rounds` - if specified along with :samp:`{hash}__default_rounds`, + If specified along with :samp:`{hash}__default_rounds`, this will cause each new hash created by :meth:`CryptContext.encrypt` to have a rounds value random chosen from the range :samp:`{default_rounds} +/- {vary_rounds}`. - this may be specified as an integer value, or as a string containing an integer + This may be specified as an integer value, or as a string containing an integer with a percent suffix (eg: ``"10%"``). if specified as a percent, the amount varied will be calculated as a percentage of the :samp:`{default_rounds}` value. - The default passlib policy sets this to ``"10%"``. + The default Passlib policy sets this to ``"10%"``. .. note:: |