Opened 6 years ago

Closed 5 years ago

#11273 closed (wontfix)

Tutorial - Part 2 should note the first appearance of curly brackets

Reported by: thiggins Owned by: nobody
Component: Documentation Version: 1.0
Severity: Keywords: curly brackets
Cc: Triage Stage: Design decision needed
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

Curly brackets are visually hard to distinguish from parentheses at ordinary screen resolutions. Their use may go unnoticed by the student, leading to frustration. I recommend noting their first appearance in Part 2 of the documentation. Some remarks about the conventions governing their use might also be in order.

Nice documentation generally -- thanks.

Tom

Change History (3)

comment:1 Changed 6 years ago by SmileyChris

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Design decision needed

comment:2 Changed 6 years ago by SmileyChris

  • Component changed from Uncategorized to Documentation

comment:3 Changed 5 years ago by gabrielhurley

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

The first appearance of the curly brackets is their use in some dicts during the admin setup examples. I'm assuming the ticket was actually more interested in where they're first used regarding templates, however.

The first time they're used/mentioned is the line "This template file contains lots of text like {% block branding %} and {{ title }}." I think that calls attention to them pretty adequately. It specifically points out this syntax as something you should notice.

Moreover, if you mistake a curly bracket for a parenthesis in a template, you're going to know you've made a mistake pretty much immediately. And if you're copying and pasting code (as many people do with the tutorial), then you should be able to distinguish the curly bracket in your text-editor of choice.

Thereby, I'm going to close this one wontfix. Thank you to thiggins for the suggestion, however.

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