[Django] #36625: Please mention quit() when instucting the user to "restart the shell" in tutorial 2

[Django]

#36625: Please mention quit() when instucting the user to "restart the shell" in
tutorial 2
-------------------------------------+-------------------------------------
Reporter: Charles Severance | Type:
| Cleanup/optimization
Status: new | Component:
| Documentation
Version: 5.2 | Severity: Normal
Keywords: tutorial | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
This is pretty simple. In tutorial 2:

https://docs.djangoproject.com/en/5.2/intro/tutorial02/

It has the following statement:

Save these changes and start a new Python interactive shell by running
**python manage.py shell** again:

It should be reworded to say:

Save these changes and start a new Python interactive shell by running
**python manage.py shell** again. If your command line is currently in
the shell with a three-chevron prompt (>>>), you need to exit the current
shell using **quit()** and then run python manage.py shell from the
command line.
--
Ticket URL: <https://code.djangoproject.com/ticket/36625>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#36625: Please mention quit() when instucting the user to "restart the shell" in
tutorial 2
-------------------------------------+-------------------------------------

Reporter: Charles Severance | Owner: (none)
Type: | Status: new
Cleanup/optimization |
Component: Documentation | Version: 5.2
Severity: Normal | Resolution:

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

Description changed by Charles Severance:

Old description:

> This is pretty simple. In tutorial 2:
>
> https://docs.djangoproject.com/en/5.2/intro/tutorial02/
>
> It has the following statement:
>
> Save these changes and start a new Python interactive shell by running
> **python manage.py shell** again:
>
> It should be reworded to say:
>
> Save these changes and start a new Python interactive shell by running
> **python manage.py shell** again. If your command line is currently in
> the shell with a three-chevron prompt (>>>), you need to exit the current
> shell using **quit()** and then run python manage.py shell from the
> command line.

New description:

This is pretty simple. In tutorial 2:

https://docs.djangoproject.com/en/5.2/intro/tutorial02/

It has the following statement:

Save these changes and start a new Python interactive shell by running
**python manage.py shell** again:

It should be reworded to say:

Save these changes and start a new Python interactive shell by running
**python manage.py shell** again.

If you are currently in the shell with a three-chevron prompt (>>>), you

need to exit the current

shell using ``quit()`` and then run ``python manage.py shell`` again to
reload the shell
with the new models.

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

[Django]

#36625: Please mention quit() when instucting the user to "restart the shell" in
tutorial 2
-------------------------------------+-------------------------------------
Reporter: Charles Severance | Owner: (none)
Type: | Status: new
Cleanup/optimization |
Component: Documentation | Version: 5.2
Severity: Normal | Resolution:
Keywords: tutorial | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Charles Severance):

I already have patch at

https://github.com/csev/django/tree/ticket_36625

I did not submit a PR because I figured I probably had to submit a
contribution agreement or something. Also this ticket could use some
review methinks. Thanks in advance.
--
Ticket URL: <https://code.djangoproject.com/ticket/36625#comment:2>

[Django]

#36625: Please mention quit() when instucting the user to "restart the shell" in
tutorial 2
-------------------------------------+-------------------------------------
Reporter: Charles Severance | Owner: (none)
Type: | Status: new
Cleanup/optimization |
Component: Documentation | Version: 5.2
Severity: Normal | Resolution:
Keywords: tutorial | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Adam Johnson):

Seems like a reasonable improvement.

Small bikeshed: I think `exit()` is more common. It's also worth noting
that from Python 3.13+ onwards, the parentheses are not required:
https://docs.python.org/3/whatsnew/3.13.html#:~:text=Direct%20support%20for%20REPL%2Dspecific%20commands%20like%20help%2C%20exit%2C%20and%20quit%2C%20without%20the%20need%20to%20call%20them%20as%20functions
--
Ticket URL: <https://code.djangoproject.com/ticket/36625#comment:3>

[Django]

#36625: Please mention quit() when instucting the user to "restart the shell" in
tutorial 2

--------------------------------------+------------------------------------

Reporter: Charles Severance | Owner: (none)

Type: Cleanup/optimization | Status: new

Component: Documentation | Version: 5.2
Severity: Normal | Resolution:

Keywords: tutorial | Triage Stage: Accepted

Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0

--------------------------------------+------------------------------------
Changes (by Adam Johnson):

* stage: Unreviewed => Accepted

--
Ticket URL: <https://code.djangoproject.com/ticket/36625#comment:4>

[Django]

#36625: Please mention quit() when instucting the user to "restart the shell" in
tutorial 2

-------------------------------------+-------------------------------------
Reporter: Charles Severance | Owner: arsalan64
Type: | Status: assigned
Cleanup/optimization |

Component: Documentation | Version: 5.2
Severity: Normal | Resolution:
Keywords: tutorial | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0

-------------------------------------+-------------------------------------
Changes (by arsalan64):

* owner: (none) => arsalan64
* status: new => assigned

Comment:

Self-assigning to start working on this
--
Ticket URL: <https://code.djangoproject.com/ticket/36625#comment:5>

[Django]

#36625: Please mention quit() when instucting the user to "restart the shell" in
tutorial 2
-------------------------------------+-------------------------------------
Reporter: Charles Severance | Owner: arsalan64
Type: | Status: assigned
Cleanup/optimization |
Component: Documentation | Version: 5.2
Severity: Normal | Resolution:
Keywords: tutorial | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by arsalan64):

* has_patch: 0 => 1

Comment:

PR : https://github.com/django/django/pull/19906
--
Ticket URL: <https://code.djangoproject.com/ticket/36625#comment:6>

[Django]

#36625: Please mention quit() when instucting the user to "restart the shell" in
tutorial 2
-------------------------------------+-------------------------------------
Reporter: Charles Severance | Owner: arsalan64
Type: | Status: assigned
Cleanup/optimization |
Component: Documentation | Version: 5.2
Severity: Normal | Resolution:
Keywords: tutorial | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 1

Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Jacob Walls):

* needs_better_patch: 0 => 1

--
Ticket URL: <https://code.djangoproject.com/ticket/36625#comment:7>