Opened 5 years ago

Closed 5 years ago

Last modified 5 years ago

#16669 closed Cleanup/optimization (fixed)

tutorial01: inconsistent formatting for django-admin.py interactions

Reported by: Danny Lawrence Owned by: nobody
Component: Documentation Version: master
Severity: Normal Keywords: tutorial01, formatting
Cc: Triage Stage: Ready for checkin
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no

Description

The tutorial01 contains the syntax to start a new project - django-admin.py startproject mysite

However its not the same formatting that the start application follows

As a new user it was immediately obvious that it is an important step or that it was syntax that need to be entered.

Page: https://docs.djangoproject.com/en/dev/intro/tutorial01/

Index: docs/intro/tutorial01.txt
===================================================================
--- docs/intro/tutorial01.txt	(revision 16642)
+++ docs/intro/tutorial01.txt	(working copy)
@@ -36,9 +36,14 @@
 application-specific settings.
 
 From the command line, ``cd`` into a directory where you'd like to store your
-code, then run the command ``django-admin.py startproject mysite``. This will
-create a ``mysite`` directory in your current directory.
+code, then run the following command:
 
+.. code-block:: bash
+
+   django-admin.py startproject mysite
+   
+This will create a ``mysite`` directory in your current directory.
+
 .. admonition:: Script name may differ in distribution packages
 
    If you installed Django using a Linux distribution's package manager

Attachments (2)

start-project-formatting.diff (749 bytes) - added by Danny Lawrence 5 years ago.
patch to inline the start-project command with startapp
start-project-formatting.2.diff (771 bytes) - added by Aymeric Augustin 5 years ago.

Download all attachments as: .zip

Change History (5)

Changed 5 years ago by Danny Lawrence

patch to inline the start-project command with startapp

comment:1 Changed 5 years ago by Aymeric Augustin

Needs documentation: unset
Needs tests: unset
Patch needs improvement: unset
Triage Stage: UnreviewedReady for checkin

Patch should be relative to the "trunk" directory. I'm uploading a correct version. Besides this it's perfect.

Changed 5 years ago by Aymeric Augustin

comment:2 Changed 5 years ago by Julien Phalip

Resolution: fixed
Status: newclosed

In [16664]:

Fixed #16669 -- Made the startproject instruction formatting easier to read and more consistent with other formatting in the tutorial part 1. Thanks to Daniel Lawrence and Aymeric Augustin.

comment:3 Changed 5 years ago by Julien Phalip

In [16665]:

[1.3.X] Fixed #16669 -- Made the startproject instruction formatting easier to read and more consistent with other formatting in the tutorial part 1. Thanks to Daniel Lawrence and Aymeric Augustin.

Backport of r16664 from trunk.

Note: See TracTickets for help on using tickets.
Back to Top