Commit Graph

955 Commits

Author SHA1 Message Date
Gary Wilson Jr 7372ea159a Fixed #10389, #10501, #10502, #10540, #10562, #10563, #10564, #10565, #10568, #10569, #10614, #10617, #10619 -- Fixed several typos as well as a couple minor issues in the docs, patches from timo, nih, bthomas, rduffield, UloPe, and sebleier@gmail.com.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@10242 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2009-03-31 07:01:01 +00:00
Gary Wilson Jr ef933f1643 Fixed a few class references in the model field docs.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@10207 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2009-03-30 19:54:27 +00:00
Gary Wilson Jr 78cbc3acfa Fixed #10076 -- Documented invalid arguments for `FileField`, based on patch from timo.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@10204 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2009-03-30 19:31:50 +00:00
Gary Wilson Jr 8ed6b2b1d1 Fixed #9853 -- Added information to the model date/time fields to note the Python objects used to represent them.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@10198 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2009-03-30 18:30:44 +00:00
Malcolm Tredinnick 6fa30faa79 Fixed #10574 -- Documented interaction between annotations and order_by.
In the future, I'd like to fix this properly, but the current behavior
has the advantage of being consistent across the board (and changing it
everywhere is backwards-incompatible with documented functionality).

git-svn-id: http://code.djangoproject.com/svn/django/trunk@10172 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2009-03-25 09:05:38 +00:00
Russell Keith-Magee cce822c0f5 Fixed #10329 -- Added link target for get_FOO_display, get_next_by_FOO, and get_previous_by_FOO. Thanks to rctay for the report, and timo for the patch.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@10152 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2009-03-24 11:46:18 +00:00
Jacob Kaplan-Moss 4246c832b6 Added 1.1 beta release notes.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@10130 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2009-03-23 23:25:03 +00:00
Gary Wilson Jr 10923b42b3 Corrected syntax typos in a couple of versionadded directives.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@10112 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2009-03-21 15:28:51 +00:00
Malcolm Tredinnick 4eadcf45d4 Added some further clarification to the docs for Meta.managed.
Not sure if any of these are noticed as omissions yet; it's too new.
Primarily trying to head off questions in the future.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@10107 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2009-03-20 23:15:27 +00:00
Malcolm Tredinnick 729c974e64 Fixed #10546 -- Fixed a docs typo noticed by carljm.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@10093 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2009-03-19 22:46:49 +00:00
Malcolm Tredinnick 29050ef999 Fixed #5420 -- Added support for delayed loading of model fields.
In extreme cases, some fields are expensive to load from the database
(e.g. GIS fields requiring conversion, or large text fields). This
commit adds defer() and only() methods to querysets that allow the
caller to specify which fields should not be loaded unless they are
accessed.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@10090 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2009-03-19 09:06:04 +00:00
Malcolm Tredinnick 96d5d434fa Added some documentation explaining "managed=False" vs. "proxy=True".
These features look similar, but they're not identical. They can't be merged
into one (without requiring at least two Meta parameters anyway), so we've made
them have APIs that match their natural use-cases most easily.

Anyway, the documentation explains both the details and gives some simple to
follow rules.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@10089 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2009-03-19 09:04:19 +00:00
Malcolm Tredinnick 61a2708c41 Fixed #10356 -- Added pure-Python inheritance for models (a.k.a proxy models).
Large portions of this are needed for #5420, so I implemented it fully.
Thanks to Ryan Kelly for an initial patch to get this started.

Refs #5420.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@10083 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2009-03-18 09:47:08 +00:00
Malcolm Tredinnick b4dd4d4bb7 Fixed #3163 -- Add a "Meta.managed" option to models.
This allows a model to be defined which is not subject to database table
creation and removal. Useful for models that sit over existing tables or
database views.

Thanks to Alexander Myodov, Wolfgang Kriesing and Ryan Kelly for the bulk of
this patch.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@10008 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2009-03-09 03:35:02 +00:00
Malcolm Tredinnick 98710a5a28 Made a couple of cross-references in the model fields documentaiton consistent.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@10007 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2009-03-09 03:33:54 +00:00
Ian Kelly ad6ce1e6f9 Clarified documentation regarding Oracle's treatment of nulls and empty strings.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@9976 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2009-03-05 20:21:22 +00:00
Russell Keith-Magee 0c2a5ebe97 Fixed #9347 -- Added an entry in the field reference for the verbose_name option. Thanks to marcoberi for the suggestion, and timo for the eventual patch.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@9865 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2009-02-22 06:10:29 +00:00
Russell Keith-Magee a50a188a62 Fixed #9939 -- Corrected minor error in model fields documentation. Thanks to seemant for the report.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@9864 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2009-02-22 06:09:54 +00:00
Russell Keith-Magee e83f81de8c Clarified some documentation on the use of the aggregate() query modifier, following suggestions on IRC. Thanks to Tai Lee for the report.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@9844 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2009-02-17 10:17:29 +00:00
Karen Tracey addd3df3bd Fixed #7672 -- Added a 'week_day' lookup type. Many thanks to Ross Poulton for the proposal and implementation on all built-in database backends..
git-svn-id: http://code.djangoproject.com/svn/django/trunk@9818 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2009-02-08 05:08:06 +00:00
Malcolm Tredinnick d579e716fe Fixed #9997 -- Fixed use of ValuesQuerySets as rvalues in filters.
Previous behaviour was pretty stupid. Let's never speak of it again. New
behaviour both works and is documented.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@9759 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2009-01-16 10:59:43 +00:00
Russell Keith-Magee 1a87e01f21 Corrected some ReST problems with the aggregation docs. Thanks to James Bennett for the report.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@9743 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2009-01-15 12:13:17 +00:00
Russell Keith-Magee cc4e4d9aee Fixed #3566 -- Added support for aggregation to the ORM. See the documentation for details on usage.
Many thanks to:
 * Nicolas Lara, who worked on this feature during the 2008 Google Summer of Code.
 * Alex Gaynor for his help debugging and fixing a number of issues.
 * Justin Bronn for his help integrating with contrib.gis.
 * Karen Tracey for her help with cross-platform testing.
 * Ian Kelly for his help testing and fixing Oracle support.
 * Malcolm Tredinnick for his invaluable review notes.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@9742 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2009-01-15 11:06:34 +00:00
Malcolm Tredinnick 3b489b7742 Documented that case-insensitive matching is not supported for non-ASCII
strings in SQLite. Refs #9905.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@9705 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2009-01-06 03:34:47 +00:00
Malcolm Tredinnick f747b61c20 Nested query support.
This extends previous functionality that allowed passing Query objects as the
rvals to filters. You can now pass QuerySets, which requires less poking at
opaque attributes. See the documentation of the "__in" lookup type for the
details.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@9701 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2009-01-05 11:47:48 +00:00
Malcolm Tredinnick b58a260c56 Fixed #9431 -- Added extra validation for VARCHAR-based fields on MySQL.
max_length > 255 and unique=True is not permitted. Based on a patch from
adamnelson.


git-svn-id: http://code.djangoproject.com/svn/django/trunk@9650 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-12-16 06:43:18 +00:00
Malcolm Tredinnick 644ad9073f Fixed #9477 -- Removed and edited a bunch of references to "development
version". Some were replaced with versionadded or versionchanged directives.
Other, more minor ones, were removed altogether.

Based on a patch from James Bennett.


git-svn-id: http://code.djangoproject.com/svn/django/trunk@9454 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-11-15 05:51:25 +00:00
Karen Tracey c483583023 Fixed #9497 - Doc typos. Many thanks ramiro.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@9330 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-11-02 20:43:20 +00:00
Malcolm Tredinnick 032b7bc45e Fixed #9420 -- Fixed an exception type in the documentation of Queryset.get().
Based on a suggestion from daveyjoe.


git-svn-id: http://code.djangoproject.com/svn/django/trunk@9257 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-10-24 07:15:52 +00:00
Malcolm Tredinnick 9900c87161 Fixed #9390 -- Restored some documentation about select_related() that was
accidentally lost in the docs refactor.


git-svn-id: http://code.djangoproject.com/svn/django/trunk@9256 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-10-24 07:15:07 +00:00
Malcolm Tredinnick e0a09b7dac Fixed a couple of markup errors in the documentation.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@9164 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-10-06 08:28:18 +00:00
James Bennett 73c0db8e42 Fixed #9255: Removed now-obsolete warning about the old semantics of __exact=None vs. __isnull=True
git-svn-id: http://code.djangoproject.com/svn/django/trunk@9105 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-09-30 22:29:58 +00:00
Malcolm Tredinnick 4eb26b1659 Restored documentation about pickling QuerySets (and how to only pickle the
details for the query, rather than the results) from r7499.

These were accidentally nuked in the docs refactor. We know who the offenders
were. They will be made to sit in the corner on the naughty mat for a while.


git-svn-id: http://code.djangoproject.com/svn/django/trunk@9090 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-09-28 03:08:30 +00:00
Russell Keith-Magee 54f962c0bf Fixed #8967: Added documentation for the 'through' option on a many-to-many field in the fields reference documentation.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@9083 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-09-22 11:07:35 +00:00
Simon Willison f17f2bfd1f Re-added docs for QuerySet reverse() and all() methods, refs #9000 - thanks ramiro
git-svn-id: http://code.djangoproject.com/svn/django/trunk@9005 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-09-11 00:24:02 +00:00
Adrian Holovaty 1aa8449fb7 Fixed #9003 -- Fixed awkward wording in querysets.txt
git-svn-id: http://code.djangoproject.com/svn/django/trunk@8996 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-09-10 03:57:52 +00:00
Jacob Kaplan-Moss 7c2e2d2b5e Added a note about queryset.query being opaque.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@8955 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-09-03 21:47:57 +00:00
Jacob Kaplan-Moss 7b0b992a87 Fixed #8849: added some more "new in 1.0" flags. Thanks, ramiro.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@8947 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-09-03 20:55:04 +00:00
Simon Willison cd5a00b4e4 Fixed #8838 - two typos in model field docs. Thanks, arien
git-svn-id: http://code.djangoproject.com/svn/django/trunk@8927 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-09-03 15:35:58 +00:00
Malcolm Tredinnick fd1d986bb1 Fixed #8802 -- Documented MySQL's usage of 1/0 instead of True/False for model
BooleanFields.


git-svn-id: http://code.djangoproject.com/svn/django/trunk@8910 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-09-03 06:14:13 +00:00
Jacob Kaplan-Moss bc768e2b47 A bunch of cleanups to file documentation. Along the way some references to the old file methods were removed - thanks, varikin.
Fixes #8642.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@8862 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-09-02 17:33:51 +00:00
Jacob Kaplan-Moss 64a9469127 Fixed #8753: converted "new in ..." callouts to proper Sphinx "versionadded/versionchanged" directives. Thanks to Marc Fargas for all the heavy lifting here.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@8843 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-09-02 03:40:42 +00:00
James Bennett c7a10b677d Fixed #8786: Moved phone number field docs to localflavor
git-svn-id: http://code.djangoproject.com/svn/django/trunk@8830 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-09-02 00:26:28 +00:00
Jacob Kaplan-Moss 3a18002bbd Fixed #8210 and #8664: moved `USStateField` and `PhoneNumberField` to `django.contrib.localflavor.us`. This is a backwards-incompatible change, albeit a minor one; just add an aditional `import` and go on your way.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@8819 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-09-01 22:15:35 +00:00
James Bennett b085ccce6c Fixed #8730: Incorporated (with minor changes) additions/enhancements to one-to-one docs
git-svn-id: http://code.djangoproject.com/svn/django/trunk@8787 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-09-01 09:32:41 +00:00
James Bennett 78ca7a6c07 Fixed #8533: restored model inheritance docs, and updated one-to-one docs to match
git-svn-id: http://code.djangoproject.com/svn/django/trunk@8757 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-08-31 10:13:32 +00:00
James Bennett f2c80f93d9 Fixed #8658: Added cross-references to signals docs from Model.save() docs
git-svn-id: http://code.djangoproject.com/svn/django/trunk@8755 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-08-31 09:03:18 +00:00
James Bennett 6ba55eee30 Fixed #8679: use full signature of Model.save() in docs and remove no-longer-used 'raw' argument
git-svn-id: http://code.djangoproject.com/svn/django/trunk@8754 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-08-31 08:55:08 +00:00
Malcolm Tredinnick 2dba41056f Revived a bunch of missing documentation that got lost in the docs-refactor.
This describes values_list(), the new cross-model order_by() syntax and the
effects of distinct(), values() and order_by() on each other.

Fixed #8634.


git-svn-id: http://code.djangoproject.com/svn/django/trunk@8694 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-08-29 05:04:26 +00:00
Malcolm Tredinnick d22ee35ee9 Fixed #8662 -- Fixed the documentation of Model.save() to match the real
signature so that people overriding it will use the right signature.


git-svn-id: http://code.djangoproject.com/svn/django/trunk@8689 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-08-29 01:44:15 +00:00
Malcolm Tredinnick c181734fa1 Changed create() and get_or_create() to force an insert (not update an existing value).
Backwards incompatible if you are using manually-specific primary key values
and relying on the previously documented behaviour that the new values would
always exist in the database (i.e. it would update the existing entry).

Fixed #8419.


git-svn-id: http://code.djangoproject.com/svn/django/trunk@8670 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-08-28 17:18:05 +00:00
Russell Keith-Magee 5c43a0a43f Fixed #8406: Corrected some expected output to use repr format. Thanks to arien for the patch.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@8658 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-08-28 13:40:20 +00:00
Gary Wilson Jr c2ba59fc1d Removed oldforms, validators, and related code:
* Removed `Manipulator`, `AutomaticManipulator`, and related classes.
 * Removed oldforms specific bits from model fields:
   * Removed `validator_list` and `core` arguments from constructors.
   * Removed the methods:
     * `get_manipulator_field_names`
     * `get_manipulator_field_objs`
     * `get_manipulator_fields`
     * `get_manipulator_new_data`
     * `prepare_field_objs_and_params`
     * `get_follow`
   * Renamed `flatten_data` method to `value_to_string` for better alignment with its use by the serialization framework, which was the only remaining code using `flatten_data`.
 * Removed oldforms methods from `django.db.models.Options` class: `get_followed_related_objects`, `get_data_holders`, `get_follow`, and `has_field_type`.
 * Removed oldforms-admin specific options from `django.db.models.fields.related` classes: `num_in_admin`, `min_num_in_admin`, `max_num_in_admin`, `num_extra_on_change`, and `edit_inline`.
 * Serialization framework
   * `Serializer.get_string_value` now calls the model fields' renamed `value_to_string` methods.
   * Removed a special-casing of `models.DateTimeField` in `core.serializers.base.Serializer.get_string_value` that's handled by `django.db.models.fields.DateTimeField.value_to_string`.
 * Removed `django.core.validators`:
   * Moved `ValidationError` exception to `django.core.exceptions`.
   * For the couple places that were using validators, brought over the necessary code to maintain the same functionality.
 * Introduced a SlugField form field for validation and to compliment the SlugField model field (refs #8040).
 * Removed an oldforms-style model creation hack (refs #2160).

git-svn-id: http://code.djangoproject.com/svn/django/trunk@8616 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-08-27 07:19:44 +00:00
Malcolm Tredinnick f2b389b354 Added documentation to explain the gains and losses when using utf8_bin
collation in MySQL. This should help people to make a reasonably informed
decision. Usually, leaving the MySQL collation alone will be the best solution,
but if you must change it, this gives a start to the information you need and
pointers to the appropriate place in the MySQL docs.

There's a small chance I also got all the necessary Sphinx markup correct, too
(it builds without errors, but I may have missed some chances for glory and
linkage).

Fixed #2335, #8506.


git-svn-id: http://code.djangoproject.com/svn/django/trunk@8568 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-08-26 01:59:25 +00:00
Jacob Kaplan-Moss 97cb07c3a1 Massive reorganization of the docs. See the new docs online at http://docs.djangoproject.com/.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@8506 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2008-08-23 22:25:40 +00:00