[Django] #34663: Documentation Typo

[Django]

#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.

[Django]

#34663: Documentation Typo
-------------------------------------+-------------------------------------
Reporter: HeartthrobRob | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Component: Documentation | Version: 4.2
Severity: Normal | Resolution:

Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by HeartthrobRob):

* ui_ux: 1 => 0

--
Ticket URL: <https://code.djangoproject.com/ticket/34663#comment:1>

[Django]

#34663: Documentation Typo
-------------------------------------+-------------------------------------
Reporter: HeartthrobRob | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Component: Documentation | Version: 4.2
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Akash Kumar Sen):

The current DOCs work perfectly fine with me, getting error with the
proposed solution instead. What OS and Configuration are you using?

--
Ticket URL: <https://code.djangoproject.com/ticket/34663#comment:2>

[Django]

#34663: Documentation Typo
-------------------------------------+-------------------------------------
Reporter: HeartthrobRob | Owner: nobody

Type: | Status: closed

Cleanup/optimization |
Component: Documentation | Version: 4.2
Severity: Normal | Resolution:

| worksforme

Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Mariusz Felisiak):

* status: new => closed
* resolution: => worksforme

Comment:

Thanks for the report, however it works for me.

--
Ticket URL: <https://code.djangoproject.com/ticket/34663#comment:3>