Opened 13 years ago

Closed 13 years ago

Last modified 13 years ago

#16369 closed Cleanup/optimization (fixed)

Remove a misleading comment from the signing documentation

Reported by: Armin Ronacher Owned by: nobody
Component: Documentation Version: dev
Severity: Normal Keywords: signing
Cc: teraom Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no

Description

Issue #16285 improved the wording in the signing docstring but the same misleading comment is still present in the actual documentation. I think it would also make sense to add an example why the salt is useful because people might be be mislead by the name salt.

Change History (4)

comment:1 by Aymeric Augustin, 13 years ago

Triage Stage: UnreviewedAccepted

The aforementioned documentation is: docs/topics/signing.txt

comment:2 by teraom, 13 years ago

Cc: teraom added

comment:3 by Malcolm Tredinnick, 13 years ago

Resolution: fixed
Status: newclosed

In [16693]:

Fixed documentation about use of salt parameter in signing functions.

Fixes #16369.

comment:4 by Jacob, 13 years ago

milestone: 1.4

Milestone 1.4 deleted

Note: See TracTickets for help on using tickets.
Back to Top