#34970 closed Cleanup/optimization (fixed)
Unclear wording in password validator docs
| Reported by: | Markus Amalthea Magnuson | Owned by: | Markus Amalthea Magnuson |
|---|---|---|---|
| Component: | Documentation | Version: | 4.2 |
| Severity: | Normal | Keywords: | |
| Cc: | Triage Stage: | Ready for checkin | |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | no | UI/UX: | no |
Description
This page has the following paragraph:
Each password validator must provide a help text to explain the requirements to the user, validate a given password and return an error message if it does not meet the requirements, and optionally receive passwords that have been set. Validators can also have optional settings to fine tune their behavior.
It's unclear to me what "optionally receive passwords" means. Is it a typo?
Change History (7)
comment:1 by , 13 months ago
comment:2 by , 13 months ago
| Triage Stage: | Unreviewed → Accepted |
|---|
Hi Markus, thanks for the ticket. I agree the wording is confusing, accepting. Would you like to propose a patch?
comment:4 by , 13 months ago
| Triage Stage: | Accepted → Ready for checkin |
|---|
Note:
See TracTickets
for help on using tickets.
It could be a little clearer but I believe it's referring to optional extra information like a dictionary of common passwords that are blacklisted.
Do you have suggestions on how to improve it? If you do you're welcome to submit a doc PR ☺️ 👍