Code

Opened 3 years ago

Closed 3 years ago

Last modified 3 years ago

#16369 closed Cleanup/optimization (fixed)

Remove a misleading comment from the signing documentation

Reported by: mitsuhiko Owned by: nobody
Component: Documentation Version: master
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.

Attachments (0)

Change History (4)

comment:1 Changed 3 years ago by aaugustin

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted

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

comment:2 Changed 3 years ago by teraom

  • Cc teraom added

comment:3 Changed 3 years ago by mtredinnick

  • Resolution set to fixed
  • Status changed from new to closed

In [16693]:

Fixed documentation about use of salt parameter in signing functions.

Fixes #16369.

comment:4 Changed 3 years ago by jacob

  • milestone 1.4 deleted

Milestone 1.4 deleted

Add Comment

Modify Ticket

Change Properties
<Author field>
Action
as closed
as The resolution will be set. Next status will be 'closed'
The resolution will be deleted. Next status will be 'new'
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.