mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-07-05 02:09:13 +00:00
Code Issues 32 Releases Wiki Activity

magic-removal: Proofread docs/design_philosophies.txt

Browse Source 
git-svn-id: http://code.djangoproject.com/svn/django/branches/magic-removal@2759 bcc190cf-cafb-0310-a4f2-bffc1f526a37
This commit is contained in:
Adrian Holovaty 2006-04-28 03:54:24 +00:00
parent c32bd868c6
commit 04f3bcfd4d
1 changed files with 19 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/design_philosophies.txt
View File

@ -20,6 +20,9 @@ For example, the template system knows nothing about Web requests, the database
layer knows nothing about data display and the view system doesn't care which layer knows nothing about data display and the view system doesn't care which
template system a programmer uses. template system a programmer uses.
Although Django comes with a full stack for convenience, the pieces of the
stack are independent of another wherever possible.
.. _`loose coupling and tight cohesion`: http://c2.com/cgi/wiki?CouplingAndCohesion .. _`loose coupling and tight cohesion`: http://c2.com/cgi/wiki?CouplingAndCohesion
Less code Less code
@ -49,7 +52,10 @@ Explicit is better than implicit
-------------------------------- --------------------------------
This, a `core Python principle`_, means Django shouldn't do too much "magic." This, a `core Python principle`_, means Django shouldn't do too much "magic."
Magic shouldn't happen unless there's a really good reason for it. Magic shouldn't happen unless there's a really good reason for it. Magic is
worth using only if it creates a huge convenience unattainable in other ways,
and it isn't implemented in a way that confuses developers who are trying to
learn how to use the feature.
.. _`core Python principle`: http://www.python.org/doc/Humor.html#zen .. _`core Python principle`: http://www.python.org/doc/Humor.html#zen
@ -96,8 +102,9 @@ optimize statements internally.
This is why developers need to call ``save()`` explicitly, rather than the This is why developers need to call ``save()`` explicitly, rather than the
framework saving things behind the scenes silently. framework saving things behind the scenes silently.
This is also why the ``select_related`` argument exists. It's an optional This is also why the ``select_related()`` ``QuerySet`` method exists. It's an
performance booster for the common case of selecting "every related object." optional performance booster for the common case of selecting "every related
object."
Terse, powerful syntax Terse, powerful syntax
---------------------- ----------------------
@ -144,6 +151,8 @@ design pretty URLs than ugly ones.
File extensions in Web-page URLs should be avoided. File extensions in Web-page URLs should be avoided.
Vignette-style commas in URLs deserve severe punishment.
Definitive URLs Definitive URLs
--------------- ---------------
@ -186,6 +195,13 @@ The template system shouldn't be designed so that it only outputs HTML. It
should be equally good at generating other text-based formats, or just plain should be equally good at generating other text-based formats, or just plain
text. text.
XML should not be used for template languages
---------------------------------------------
Using an XML engine to parse templates introduces a whole new world of human
error in editing templates -- and incurs an unacceptable level of overhead in
template processing.
Assume designer competence Assume designer competence
-------------------------- --------------------------