Opened 4 years ago

Closed 4 years ago

#17490 closed Cleanup/optimization (fixed)

A few minor typos

Reported by: malcolm.newsome@… Owned by: nobody
Component: Documentation Version: 1.3
Severity: Normal Keywords: tutorial
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

I noticed a couple minor typos while going through the tutorial. They probably won't trip up a seasoned programmer, but likely to be a problem for a complete newbie.

  1. When adding polls to INSTALLED_APPS, the comma is missing after it - https://docs.djangoproject.com/en/1.3/intro/tutorial01/
  1. Suggestion to add a prompt to run syncdb again after "Make poll app modifiable" section. https://docs.djangoproject.com/en/1.3/intro/tutorial02/

I think the tutorial is great! I am still pretty new to programming altogether and found the format, explanations, hyperlinks (to read more about a particular topic), etc to be very, very, very helpful. Looking forward to diving into the rest.

Change History (2)

comment:1 in reply to: ↑ description Changed 4 years ago by aaugustin

  • Component changed from Uncategorized to Documentation
  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Ready for checkin
  • Type changed from Uncategorized to Cleanup/optimization

Replying to malcolm.newsome@…:

  1. When adding polls to INSTALLED_APPS, the comma is missing after it - https://docs.djangoproject.com/en/1.3/intro/tutorial01/

Yes, while the current code is correct, it's still a good idea to include a trailing comma, to avoid being tripped up by Python's automatic string concatenation.

  1. Suggestion to add a prompt to run syncdb again after "Make poll app modifiable" section. https://docs.djangoproject.com/en/1.3/intro/tutorial02/

This instruction is given in the "Activate the admin site", just after adding "django.contrib.admin" to INSTALLED_APPS. There's no reason to mention it again, is there?

Thanks for your feedback!

comment:2 Changed 4 years ago by aaugustin

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

In [17324]:

Fixed #17490 -- Added a trailing comma in INSTALLED_APPS, to avoid unexpected string concatenation when adding another app.

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