#2087 closed defect (fixed)

clarify the literal command-lines in quickstart.rst

Reported by: ya Owned by: marlowe
Priority: normal Milestone: 1.10.1
Component: documentation Version: 1.10.0
Keywords: easy usability new-user Cc:
Launchpad Bug:

Description

change Run python setup.py build into Run "python setup.py build" otherwise people might forget the last part !

Change History (5)

comment:1 Changed at 2013-09-28T19:23:36Z by zooko

ya and I are at the GNU 30th Birthday Party, and she tried to follow the quickstart, but she got stuck because she thought it said to run "python setup.py" instead of to run "python setup.py build".

comment:2 Changed at 2013-09-29T03:29:05Z by zooko

  • Keywords easy usability new-user added
  • Summary changed from change the instruction for installing to clarify the literal command-lines in quickstart.rst

So, to fix this ticket, just edit docs/quickstart.rst and put quote marks around the literal command-lines. To fix this ticket even better, figure out how to put some nice formatting, such as a different-colored background around the literal command-lines. That would probably require learning how to embed HTML into the reStructuredText file… (http://stackoverflow.com/questions/4669689/how-to-use-color-in-text-with-restructured-text-rst2html-py-or-how-to-insert-h)

comment:3 Changed at 2013-09-29T03:29:14Z by zooko

  • Component changed from unknown to documentation
  • Owner changed from daira to marlowe

comment:4 Changed at 2013-10-05T17:57:20Z by daira

  • Resolution set to fixed
  • Status changed from new to closed

Fixed in [3529d31192595c16cbaf3157e8d2077fb8671a5c/trunk] (just the quotes). I'd rather keep quickstart.rst readable as text than get all fancy with the HTML.

Last edited at 2013-10-05T17:57:37Z by daira (previous) (diff)

comment:5 Changed at 2013-10-05T17:58:08Z by daira

  • Milestone changed from undecided to 1.11.0
Note: See TracTickets for help on using tickets.