Commit Graph

282 Commits

Author SHA1 Message Date
Adam Johnson d17b380653 Refs #30573 -- Rephrased "Of Course" and "Obvious(ly)" in documentation and comments. 2020-05-04 12:10:47 +02:00
Adam Johnson 787981f9d1 Corrected models.FilePathField signature in docs. 2020-05-04 12:10:41 +02:00
Hasan Ramezani d6db186427
Fixed #31514 -- Fixed default form widgets in model fields docs. 2020-04-25 21:20:29 +02:00
Tim Schilling a92cc84b4a Refs #31369 -- Deprecated models.NullBooleanField in favor of BooleanField(null=True). 2020-04-24 10:10:45 +02:00
Mariusz Felisiak cc70a0343e
Fixed term warning on Sphinx 3.0.1+.
"term" role became case sensitive in Sphinx 3.0.1.
2020-04-14 09:32:09 +02:00
miigotu 210657b791 Fixed #28184 -- Allowed using a callable for FileField and ImageField storage. 2020-04-08 11:26:17 +02:00
Adam Johnson 1cdfe8d912 Prevented (and corrected) single backtick usage in docs. 2020-04-01 14:55:11 +02:00
Hasan Ramezani 6929f13254 Fixed #31368 -- Doc'd 'expression' parameter of Field.from_db_value()/Expression.convert_value(). 2020-03-18 09:37:05 +01:00
Andrey Doroschenko f1016814d8 Fixed #31313 -- Fixed is_upperclass() example in enumeration types docs. 2020-02-27 08:33:05 +01:00
Daniel Izquierdo 89abecc75d Fixed #27272 -- Added an on_delete RESTRICT handler to allow cascading deletions while protecting direct ones. 2019-11-19 10:55:05 +01:00
Caio Ariede 555bebe774 Fixed #30987 -- Added models.PositiveBigIntegerField. 2019-11-19 09:34:11 +01:00
Mariusz Felisiak 343afa7880 Refs #29915 -- Doc'd limitation of using pattern lookups with UUIDField on PostgreSQL. 2019-09-23 08:24:00 +02:00
Claude Paroz b8dff52f44 Fixed #29823 -- Doc'd limitation of DecimalField on SQLite. 2019-09-14 17:10:08 +02:00
Nick Pope 1c66767d4e Refs #27910 -- Improved documentation for model field choice enumeration types. 2019-09-13 15:37:40 +02:00
Tobias Kunze 4a954cfd11 Fixed #30573 -- Rephrased documentation to avoid words that minimise the involved difficulty.
This patch does not remove all occurrences of the words in question.
Rather, I went through all of the occurrences of the words listed
below, and judged if they a) suggested the reader had some kind of
knowledge/experience, and b) if they added anything of value (including
tone of voice, etc). I left most of the words alone. I looked at the
following words:

- simply/simple
- easy/easier/easiest
- obvious
- just
- merely
- straightforward
- ridiculous

Thanks to Carlton Gibson for guidance on how to approach this issue, and
to Tim Bell for providing the idea. But the enormous lion's share of
thanks go to Adam Johnson for his patient and helpful review.
2019-09-06 13:27:46 +02:00
Shai Berger 72ebe85a26 Fixed #27910 -- Added enumeration helpers for use in Field.choices.
These classes can serve as a base class for user enums, supporting
translatable human-readable names, or names automatically inferred
from the enum member name.

Additional properties make it easy to access the list of names, values
and display labels.

Thanks to the following for ideas and reviews:

Carlton Gibson, Fran Hrženjak, Ian Foote, Mariusz Felisiak, Shai Berger.

Co-authored-by: Shai Berger <shai@platonix.com>
Co-authored-by: Nick Pope <nick.pope@flightdataservices.com>
Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
2019-09-04 14:42:49 +02:00
Claude Paroz d1c2e6dd04 Refs #28428 -- Made FileField.upload_to support pathlib.Path. 2019-08-18 20:34:58 +02:00
Nick Pope 194d1dfc18 Fixed #30661 -- Added models.SmallAutoField. 2019-08-02 11:39:01 +02:00
Jon Dufresne 5ed20b3aa3 Fixed #30657 -- Allowed customizing Field's descriptors with a descriptor_class attribute.
Allows model fields to override the descriptor class used on the model
instance attribute.
2019-07-25 08:15:20 +02:00
Nadège Michel 87b1ad6e73 Fixed #30421 -- Allowed symmetrical intermediate table for self-referential ManyToManyField. 2019-06-21 15:03:17 +02:00
Caio Ariede 5248abe9b0 Fixed #30505 -- Doc'd how changes in the order of Field.choices affect migrations. 2019-06-04 14:11:41 +02:00
Jon Dufresne e86cc14bd3 Changed docs to link to Python's description of iterable. 2019-05-17 17:27:19 +02:00
Jon Dufresne 97d3321e89 Changed tuple choices to list in docs. 2019-05-15 14:31:42 +02:00
Mykola Kokalko ef082ebb84 Fixed #29529 -- Allowed models.fields.FilePathField to accept a callable path. 2019-05-02 11:11:56 +02:00
Mariusz Felisiak b0799f5d86
Fixed documentation of database representation for ManyToManyField. 2019-02-25 20:05:31 +01:00
Tim Graham ec7e179aeb Removed versionadded/changed annotations for 2.1. 2019-01-17 10:50:25 -05:00
François Freitag 9b15ff08ba Used auto-numbered lists in documentation. 2018-11-15 13:54:28 -05:00
Andrea Rabbaglietti 1b49b792e9 Emphasized that ForeignKey.on_delete doesn't create a SQL constraint. 2018-10-10 14:56:50 -04:00
Jon Dufresne b3b47bf515 Added tests for using bytearray with BinaryField and corrected docs. 2018-10-01 09:16:16 -04:00
Jon Dufresne fb2964a410 Added test of filtering on BinaryField and corrected docs. 2018-09-26 14:38:12 -04:00
Jon Dufresne 8c3e0eb1c1 Normalized spelling of "lowercase" and "lowercased". 2018-09-25 10:30:18 -04:00
Curtis Maloney c49ea6f591 Refs #20910 -- Replaced snippet directive with code-block. 2018-09-10 13:00:34 -04:00
Matt Wiens c122a7c53c Fixed typo in docs/ref/models/fields.txt. 2018-08-28 07:53:09 -04:00
Jeff 3fa3de5415 Fixed #29646 -- Doc'd the validators that each model and form field uses. 2018-08-16 17:03:28 -04:00
Claude Paroz 6e78e10549 Added doc links for django.utils.html.escape(). 2018-07-18 11:32:27 -04:00
Tim Graham 8b1d361f28
Fixed #29549 -- Doc'd that Field.choices are enforced by model validation. 2018-07-09 15:06:36 -04:00
Srinivas Reddy Thatiparthy 4c35a173e8 Fixed #29423 -- Documented Field.value_from_object(). 2018-05-25 15:10:45 -04:00
Tim Graham e038f98bf3 Fixed #29398 -- Doc'd that cascade deletion doesn't call delete() of related models. 2018-05-18 18:08:37 -04:00
Tim Graham 5fa4f40f45 Fixed #29227 -- Allowed BooleanField to be null=True.
Thanks Lynn Cyrin for contributing to the patch, and Nick Pope for review.
2018-03-20 12:10:10 -04:00
Cameron Curry 622ead6aaf Fixed #28937 -- Allowed BinaryField to be editable=True. 2017-12-22 16:31:46 -05:00
Tim Graham 5446b72003 Removed versionadded/changed annotations for 1.11. 2017-09-22 12:51:18 -04:00
Tim Graham 6e4a34580d Fixed #28557 -- Fixed ForeignKey/OneToOneField/ManyToManyField argument name in docs. 2017-09-01 20:03:32 -04:00
Tim Graham 50a97edc1a Fixed #28466 -- Clarified the definition of a lazy relationship. 2017-08-07 15:51:46 -04:00
Tim Graham 487362fa8f Fixed #28370 -- Deprecated the context arg of Field.from_db_value() and Expression.convert_value().
Unused since a0d166306f.
2017-07-20 16:30:08 -04:00
Josh Schneier 98ee57e343 Removed nonexistent methods from File's docs.
read() and write() were removed in 68a890e79f.
2017-04-25 19:49:00 -04:00
Taavi Teska 5dbf1c4b23 Fixed #27947 -- Doc'd that model Field.error_messages often don't propagate to forms. 2017-04-10 14:24:44 -04:00
Mariusz Felisiak a3af8c99d9 Removed extra characters in docs header underlines. 2017-03-20 18:30:32 -04:00
Tim Graham 2d96c027f5 Refs #23919 -- Removed obsolete MySQLdb references. 2017-01-25 10:16:10 -05:00
Tim Graham e27e4c0339 Removed versionadded/changed annotations for 1.10. 2017-01-17 20:52:05 -05:00
Tim Graham bcf3532ede Refs #26154 -- Removed deprecated CommaSeparatedIntegerField. 2017-01-17 20:52:02 -05:00