Opened 8 months ago

Closed 8 months ago

Last modified 8 months ago

#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 David Sanders, 8 months ago

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 ☺️ πŸ‘

comment:2 by Natalia Bidart, 8 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:3 by Markus Amalthea Magnuson, 8 months ago

Has patch: set
Owner: changed from nobody to Markus Amalthea Magnuson
Status: new β†’ assigned

comment:4 by Natalia Bidart, 8 months ago

Triage Stage: Accepted β†’ Ready for checkin

comment:5 by Natalia Bidart <124304+nessita@…>, 8 months ago

Resolution: β†’ fixed
Status: assigned β†’ closed

In 61c305f:

Fixed #34970 -- Clarified Password Validation docs regarding the password_changed callback.

comment:6 by Natalia Bidart <124304+nessita@…>, 8 months ago

In 47f9b8d:

[4.2.x] Fixed #34970 -- Clarified Password Validation docs regarding the password_changed callback.

Backport of 61c305f298da1b4079a80721c861d0663dc8717e from main

comment:7 by Natalia Bidart <124304+nessita@…>, 8 months ago

In 8c88ae8:

[5.0.x] Fixed #34970 -- Clarified Password Validation docs regarding the password_changed callback.

Backport of 61c305f298da1b4079a80721c861d0663dc8717e from main

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