[Django] #31385: Suggestion to remove ambiguity in tutorial01 in the use of the phrase 'next to' perhaps change to 'in same directory'
Django
to' perhaps change to 'in same directory'
-------------------------------------+-------------------------------------
Reporter: | Owner: nobody
KevinBaileyCrum |
Type: | Status: new
Uncategorized |
Component: | Version: 3.0
Uncategorized |
Severity: Normal | Keywords: Tutorial Ambiguity
Triage Stage: | Has patch: 0
Unreviewed |
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 1
UI/UX: 0 |
-------------------------------------+-------------------------------------
In tutorial 01 (https://docs.djangoproject.com/en/3.0/intro/tutorial01/)
after running start project the tutorial tells the user to add an app to
the project. The tutorial uses plain English to state
{{{
Your apps can live anywhere on your Python path. In this tutorial, we’ll
create our poll app right next to your manage.py file so that it can be
imported as its own top-level module, rather than a submodule of mysite.
}}}
The problem lies with the use of 'right next to'.
While the tutorial does say 'top-level' that nuance can be missed by many.
The tutorial also shows the directory tree of the project before adding
the app and it is not entirely clear what directory one is in when they
run the add app command.
I feel that if we have the language (eg the word directory) to describe
where the command should be run and where the files should be this can
help remove ambiguity that lives in a crucial step of the tutorial.
--
Ticket URL: <https://code.djangoproject.com/ticket/31385>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
to' perhaps change to 'in same directory'
-------------------------------------+-------------------------------------
| victorcmoura
Type: Uncategorized | Status: assigned
Component: Uncategorized | Version: 3.0
Severity: Normal | Resolution:
Keywords: Tutorial Ambiguity | Triage Stage:
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
* owner: nobody => victorcmoura
* status: new => assigned
Comment:
I agree that the term "in the same directory" or "in the same folder"
would be more clear
--
Ticket URL: <https://code.djangoproject.com/ticket/31385#comment:1>
Django
to' perhaps change to 'in same directory'
-------------------------------------+-------------------------------------
| victorcmoura
Type: Uncategorized | Status: assigned
Severity: Normal | Resolution:
Keywords: Tutorial Ambiguity | Triage Stage:
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
* component: Uncategorized => Documentation
--
Ticket URL: <https://code.djangoproject.com/ticket/31385#comment:2>
Django
-------------------------------------+-------------------------------------
Reporter: Kevin Crum | Owner: Victor
Type: | Moura
Cleanup/optimization | Status: assigned
Component: Documentation | Version: 3.0
Severity: Normal | Resolution:
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
* has_patch: 0 => 1
* type: Uncategorized => Cleanup/optimization
* stage: Unreviewed => Accepted
Comment:
This sounds a really minor to me, but let's have it.
[https://github.com/django/django/pull/12614 PR]
--
Ticket URL: <https://code.djangoproject.com/ticket/31385#comment:3>
Django
-------------------------------------+-------------------------------------
Reporter: Kevin Crum | Owner: Victor
Type: | Moura
Component: Documentation | Version: 3.0
Severity: Normal | Resolution: fixed
Keywords: Tutorial Ambiguity | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
* status: assigned => closed
* resolution: => fixed
Comment:
In [changeset:"1628b35b586e07ea47a82713192d0e4662268686" 1628b35b]:
{{{
#!CommitTicketReference repository=""
revision="1628b35b586e07ea47a82713192d0e4662268686"
Fixed #31385 -- Improved wording in tutorial 1.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/31385#comment:4>
Django
-------------------------------------+-------------------------------------
Reporter: Kevin Crum | Owner: Victor
Type: | Moura
Cleanup/optimization | Status: closed
Component: Documentation | Version: 3.0
Severity: Normal | Resolution: fixed
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"6de7a600c0013186d9551631b316bdff347a9733" 6de7a600]:
{{{
#!CommitTicketReference repository=""
revision="6de7a600c0013186d9551631b316bdff347a9733"
[3.0.x] Fixed #31385 -- Improved wording in tutorial 1.
Backport of 1628b35b586e07ea47a82713192d0e4662268686 from master
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/31385#comment:5>