#31385: Suggestion to remove ambiguity in tutorial01 in the use of the phrase
'next
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.
--
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/058.58383d895be14a2cfbdc64ce1ee4c9cd%40djangoproject.com.
