Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the unusability metadata of password #18283

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Flimm
Copy link
Contributor

@Flimm Flimm commented Jun 19, 2024

This is a small patch to documentation.

It isn't clear how set_unusable_password marks a user's password as unusable. This commit clarifies that the password field itself contains metadata marking a password as unusable.

Trac ticket number

N/A

It isn't clear how set_unusable_password marks a user's password as
unusable. This commit clarifies that the password field itself contains
metadata marking a password as unusable.
@jaap3
Copy link
Contributor

jaap3 commented Jun 21, 2024

I agree that this is an important distinction.

has_usable_password can also use some clarification. It strictly looks at the UNUSABLE_PASSWORD_PREFIX (and None) to determine that a password is usable. It considers a blank string to be usable. This is currently implied, but requires the reader to understand wat set_unusable_password does in the first place.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants