#34663: Documentation Typo
------------------------------------------------+------------------------
Reporter: HeartthrobRob | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: 4.2
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 1
UI/UX: 1 |
------------------------------------------------+------------------------
"Using Argon2 with Django" section lists the command to install argon-2
(step 1) as {{{python -m pip install django[argon2]}}}. If this is run as
written, it will produce the following error: {{{no matches found:
django[argon2]}}}.
A small formatting change is required to run successfully. the package
should be nested in quotation marks instead, so it reads: {{{python -m pip
install 'django[argon2]'}}}
This is because the zsh shell uses square brackets for globbing/pattern
matching, and they need to be escaped if they're part of an argument.
References:
1. Django docs:
https://docs.djangoproject.com/en/4.2/topics/auth/passwords/#using-argon2
-with-django
2. Solution outline: https://stackoverflow.com/a/30539963/11790080
--
Ticket URL: <https://code.djangoproject.com/ticket/34663>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/01070188cb114599-a755682c-f53b-4d84-9b09-dc0ad153e2af-000000%40eu-central-1.amazonses.com.
