From daab1f06810318cae41d20e7f1ce4aaaeb0349a9 Mon Sep 17 00:00:00 2001 From: Adrian Holovaty Date: Thu, 12 Jun 2008 03:36:48 +0000 Subject: [PATCH] Various documentation edits from the past few changesets git-svn-id: http://code.djangoproject.com/svn/django/trunk@7619 bcc190cf-cafb-0310-a4f2-bffc1f526a37 --- docs/authentication.txt | 10 +++--- docs/django-admin.txt | 8 ++--- docs/faq.txt | 68 ++++++++++++++++++++--------------------- docs/sessions.txt | 10 +++--- docs/settings.txt | 2 ++ 5 files changed, 50 insertions(+), 48 deletions(-) diff --git a/docs/authentication.txt b/docs/authentication.txt index 8c5f5b7c3f..4ec367a8b5 100644 --- a/docs/authentication.txt +++ b/docs/authentication.txt @@ -270,17 +270,17 @@ to create a superuser at a later date, you can use a command line utility. manage.py createsuperuser --username=joe --email=joe@example.com -You will be prompted for a password. Once entered, the user is created. If you -leave off the ``--username`` or the ``--email`` option, It will prompt you for -those values as well. +You will be prompted for a password. After you enter one, the user will be +created immediately. If you leave off the ``--username`` or the ``--email`` +options, it will prompt you for those values. If you're using an older release of Django, the old way of creating a superuser on the command line still works:: python /path/to/django/contrib/auth/create_superuser.py -Where ``/path/to`` is the path to the Django codebase on your filesystem. The -``manage.py`` command is prefered since it'll figure out the correct path and +...where ``/path/to`` is the path to the Django codebase on your filesystem. The +``manage.py`` command is preferred because it figures out the correct path and environment for you. Storing additional information about users diff --git a/docs/django-admin.txt b/docs/django-admin.txt index e8e3b54945..e897727e4f 100644 --- a/docs/django-admin.txt +++ b/docs/django-admin.txt @@ -104,14 +104,14 @@ do so during ``syncdb``, or if you need to programmatically generate superuser accounts for your site(s). When run interactively, this command will prompt for a password for -the new superuser account; when run non-interactively, no password -will be set and the superuser account will not be able to log in until +the new superuser account. When run non-interactively, no password +will be set, and the superuser account will not be able to log in until a password has been manually set for it. The username and e-mail address for the new account can be supplied by using the ``--username`` and ``--email`` arguments on the command -line; if not supplied, ``createsuperuser`` will prompt for them when -running interactively. +line. If either of those is not supplied, ``createsuperuser`` will prompt for +it when running interactively. This command is only available if Django's `authentication system`_ (``django.contrib.auth``) is installed. diff --git a/docs/faq.txt b/docs/faq.txt index 5e36f1d933..6d12a95cba 100644 --- a/docs/faq.txt +++ b/docs/faq.txt @@ -226,7 +226,7 @@ When will you release Django 1.0? Short answer: When we're comfortable with Django's APIs, have added all features that we feel are necessary to earn a "1.0" status, and are ready to -begin maintaining backwards compatibility. +begin maintaining backwards compatibility. The merging of Django's `Queryset Refactor branch`_ went a long way toward Django 1.0. Merging the `Newforms Admin branch` will be another important step. @@ -260,8 +260,8 @@ Where can I find Django developers for hire? Consult our `developers for hire page`_ for a list of Django developers who would be happy to help you. -You might also be interested in posting a job to http://djangogigs.com/ . -If you want to find Django-capable people in your local area, try +You might also be interested in posting a job to http://djangogigs.com/ . +If you want to find Django-capable people in your local area, try http://djangopeople.net/ . .. _developers for hire page: http://code.djangoproject.com/wiki/DevelopersForHire @@ -646,18 +646,18 @@ You can also use the Python API. See `creating users`_ for full info. .. _creating users: ../authentication/#creating-users -Getting Help +Getting help ============ How do I do X? Why doesn't Y work? Where can I go to get help? -------------------------------------------------------------- If this FAQ doesn't contain an answer to your question, you might want to -try the `django-users mailing list`_. Feel free to ask any question related -to installing, using, or debugging Django. +try the `django-users mailing list`_. Feel free to ask any question related +to installing, using, or debugging Django. -If you prefer IRC, the `#django IRC channel`_ on freenode is an active -community of helpful individuals who may be able to solve your problem. +If you prefer IRC, the `#django IRC channel`_ on the Freenode IRC network is an +active community of helpful individuals who may be able to solve your problem. .. _`django-users mailing list`: http://groups.google.com/group/django-users .. _`#django IRC channel`: irc://irc.freenode.net/django @@ -666,35 +666,36 @@ Why hasn't my message appeared on django-users? ----------------------------------------------- django-users_ has a lot of subscribers. This is good for the community, as -there are lot of people that can contribute answers to questions. +it means many people are available to contribute answers to questions. Unfortunately, it also means that django-users_ is an attractive target for -spammers. +spammers. In order to combat the spam problem, when you join the django-users_ mailing -list, we manually moderate the first message you send to the list. This means -that spammers get caught, but it also means that your first question to the +list, we manually moderate the first message you send to the list. This means +that spammers get caught, but it also means that your first question to the list might take a little longer to get answered. We apologize for any inconvenience that this policy may cause. .. _django-users: http://groups.google.com/group/django-users -Nobody on django-users answered my question? What should I do? +Nobody on django-users answered my question! What should I do? -------------------------------------------------------------- -Wait. Ask again later. Try making your question more specific, or provide -a better example of your problem. +Try making your question more specific, or provide a better example of your +problem. -Remember, the readers of django-users_ are all volunteers. If nobody has -answered your question, it may be because nobody knows the answer, it may -be because nobody can understand the question, or it may be that everybody -that can help is extremely busy. +As with most open-source mailing lists, the folks on django-users_ are +volunteers. If nobody has answered your question, it may be because nobody +knows the answer, it may be because nobody can understand the question, or it +may be that everybody that can help is busy. One thing you might try is to ask +the question on IRC -- visit the `#django IRC channel`_ on the Freenode IRC +network. -Resist any temptation to mail the `django-developers mailing list`_ in an -attempt to get an answer to your question. django-developers_ is for discussing -the development of Django itself. Attempts to use django-developers_ as -a second-tier support mechanism will not be met an enthusiastic response. +You might notice we have a second mailing list, called django-developers_ -- +but please don't e-mail support questions to this mailing list. This list is +for discussion of the development of Django itself. Asking a tech support +question there is considered quite impolite. -.. _`django-developers mailing list`: http://groups.google.com/group/django-developers .. _django-developers: http://groups.google.com/group/django-developers I think I've found a bug! What should I do? @@ -708,15 +709,14 @@ Detailed instructions on how to handle a potential bug can be found in our I think I've found a security problem! What should I do? -------------------------------------------------------- -If you think you have found a security problem with Django, please send -a message to security@djangoproject.com. This is a private list only -open to long-time, highly trusted Django developers, and its archives -are not publicly readable. +If you think you've found a security problem with Django, please send a message +to security@djangoproject.com. This is a private list only open to long-time, +highly trusted Django developers, and its archives are not publicly readable. Due to the sensitive nature of security issues, we ask that if you think you -have found a security problem, *please* don't send a message to one of the +have found a security problem, *please* don't send a message to one of the public mailing lists. Django has a `policy for handling security issues`_; -while a defect is outstanding, we would like to minimize any damage that +while a defect is outstanding, we would like to minimize any damage that could be inflicted through public knowledge of that defect. .. _`policy for handling security issues`: ../contributing/#reporting-security-issues @@ -742,10 +742,10 @@ ignored" and "a ticket has not been attended to yet." Django's ticket system contains hundreds of open tickets, of various degrees of impact on end-user functionality, and Django's developers have to review and prioritize. -On top of that - the team working on Django are all volunteers. As a result, -the amount of time that we have to work on Django is limited, and will vary -from week to week depending on how much spare time we have. If we are busy, we -may not be able to spend as much time on Django as we might want. +On top of that: the people who work on Django are all volunteers. As a result, +the amount of time that we have to work on the framework is limited and will +vary from week to week depending on our spare time. If we're busy, we may not +be able to spend as much time on Django as we might want. Besides, if your feature request stands no chance of inclusion in Django, we won't ignore it -- we'll just close the ticket. So if your ticket is still diff --git a/docs/sessions.txt b/docs/sessions.txt index 86ed49f135..da083b7713 100644 --- a/docs/sessions.txt +++ b/docs/sessions.txt @@ -139,10 +139,10 @@ It also has these methods: in 5 minutes. * If ``value`` is a ``datetime`` or ``timedelta`` object, the - session will expire at that specific time. - - * If ``value`` is ``0`` then the user's session cookie will expire - when their browser is closed. + session will expire at that specific date/time. + + * If ``value`` is ``0``, the user's session cookie will expire + when the user's Web browser is closed. * If ``value`` is ``None``, the session reverts to using the global session expiry policy. @@ -168,7 +168,7 @@ It also has these methods: **New in Django development version** Returns either ``True`` or ``False``, depending on whether the user's - session cookie will expire when their browser is closed. + session cookie will expire when the user's Web browser is closed. You can edit ``request.session`` at any point in your view. You can edit it multiple times. diff --git a/docs/settings.txt b/docs/settings.txt index 9b89c92343..02e458fcda 100644 --- a/docs/settings.txt +++ b/docs/settings.txt @@ -394,6 +394,8 @@ site with ``DEBUG`` turned on. DEBUG_PROPAGATE_EXCEPTIONS -------------------------- +**New in Django development version** + Default: ``False`` If set to True, Django's normal exception handling of view functions