Django

Code

Changeset 2759

Show
Ignore:
Timestamp:
04/27/06 22:54:24 (2 years ago)
Author:
adrian
Message:

magic-removal: Proofread docs/design_philosophies.txt

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • django/branches/magic-removal/docs/design_philosophies.txt

    r1218 r2759  
    2121template system a programmer uses. 
    2222 
     23Although Django comes with a full stack for convenience, the pieces of the 
     24stack are independent of another wherever possible. 
     25 
    2326.. _`loose coupling and tight cohesion`: http://c2.com/cgi/wiki?CouplingAndCohesion 
    2427 
     
    5053 
    5154This, a `core Python principle`_, means Django shouldn't do too much "magic." 
    52 Magic shouldn't happen unless there's a really good reason for it. 
     55Magic shouldn't happen unless there's a really good reason for it. Magic is 
     56worth using only if it creates a huge convenience unattainable in other ways, 
     57and it isn't implemented in a way that confuses developers who are trying to 
     58learn how to use the feature. 
    5359 
    5460.. _`core Python principle`: http://www.python.org/doc/Humor.html#zen 
     
    97103framework saving things behind the scenes silently. 
    98104 
    99 This is also why the ``select_related`` argument exists. It's an optional 
    100 performance booster for the common case of selecting "every related object." 
     105This is also why the ``select_related()`` ``QuerySet`` method exists. It's an 
     106optional performance booster for the common case of selecting "every related 
     107object." 
    101108 
    102109Terse, powerful syntax 
     
    144151 
    145152File extensions in Web-page URLs should be avoided. 
     153 
     154Vignette-style commas in URLs deserve severe punishment. 
    146155 
    147156Definitive URLs 
     
    186195should be equally good at generating other text-based formats, or just plain 
    187196text. 
     197 
     198XML should not be used for template languages 
     199--------------------------------------------- 
     200 
     201Using an XML engine to parse templates introduces a whole new world of human 
     202error in editing templates -- and incurs an unacceptable level of overhead in 
     203template processing. 
    188204 
    189205Assume designer competence