Commit Graph

536 Commits

Author SHA1 Message Date
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
Dan Swain cece802dbb Corrected typo in search docs. (#11673) 2019-08-20 10:37:48 +02:00
daniel a rios 68aeb90160 Fixed #30656 -- Added QuerySet.bulk_update() to the database optimization docs. 2019-07-29 09:52:29 +02:00
daniel a rios fe33fdc049 Refs #30656 -- Reorganized bulk methods in the database optimization docs. 2019-07-29 09:52:29 +02:00
Meysam 833878411c Fixed typo in docs/topics/db/models.txt. 2019-06-24 09:04:33 +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
Mariusz Felisiak b6c4766f53
Refs #29548 -- Updated docs for MariaDB support. 2019-05-27 19:59:49 +02:00
Akshesh 888fdf182e Fixed #30419 -- Favored Meta.indexes over Meta.index_together in optimization docs. 2019-05-22 07:34:54 +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
Przemysław Suliga af5ec222cc Used time.monotonic() instead of time.time() where applicable.
time.monotonic() available from Python 3.3:

- Nicely communicates a narrow intent of "get a local system monotonic
  clock time" instead of possible "get a not necessarily accurate Unix
  time stamp because it needs to be communicated to outside of this
  process/machine" when time.time() is used.
  
- Its result isn't affected by the system clock updates.

There are two classes of time.time() uses changed to time.monotonic()
by this change:

- measuring time taken to run some code.

- setting and checking a "close_at" threshold for for persistent db
  connections (django/db/backends/base/base.py).
2019-05-08 18:34:22 +02:00
Daniel Musketa 6fd9c9daa6 Fixed #30365 -- Fixed syntax highlighting in SQL examples.
Sphinx interprets some "%[a-z]" in SQL statements as a
"Literal.String.Interpol" which leads to incorrect highlighting.
2019-04-23 12:37:50 +02:00
Daniel Musketa ba72606760 Fixed #30347 -- Fixed typo in docs/topics/db/aggregation.txt. 2019-04-13 12:35:31 +02:00
Nick Pope 198a2a9381 Removed unnecessary /static from links to PostgreSQL docs. 2019-03-29 21:49:44 -04:00
Tim Graham a68c029e22
Used extlinks for Django's source code. 2019-03-28 20:32:17 -04:00
Tim Graham 50f09264ae Refs #29683 -- Updated multi-db docs for view permission. 2019-02-25 14:56:36 -05:00
Collin Anderson 769355c765 Fixed #9475 -- Allowed RelatedManager.add(), create(), etc. for m2m with a through model. 2019-01-15 11:12:17 -05:00
Matt Wiens e817ae74da Followed style guide for model attribute ordering. 2018-12-27 19:34:14 -05:00
François Freitag 9b15ff08ba Used auto-numbered lists in documentation. 2018-11-15 13:54:28 -05:00
Katie McLaughlin 9886dffdf4 Fixed #29940 -- Recommended using the ORM rather than raw SQL. 2018-11-13 18:15:24 -05:00
Peter Inglesby a1ffbfb801 Removed unused fields from aggregation docs. 2018-10-13 21:13:45 -04:00
Jon Dufresne 8c3e0eb1c1 Normalized spelling of "lowercase" and "lowercased". 2018-09-25 10:30:18 -04:00
Jon Dufresne ad9a28ee38 Refs #29784 -- Normalized Python docs links to omit the version. 2018-09-25 10:19:42 +02:00
Tim Graham d483a5f0dc Fixed #29756 -- Doc'd that model field names can't end with an underscore. 2018-09-14 11:38:39 -04:00
Ramiro Morales 1b1f64ee5a Refs #14357 -- Deprecated Meta.ordering affecting GROUP BY queries.
Thanks Ramiro Morales for contributing to the patch.
2018-09-13 12:29:48 -04:00
Curtis Maloney c49ea6f591 Refs #20910 -- Replaced snippet directive with code-block. 2018-09-10 13:00:34 -04:00
Vishvajit Pathak a48bc0cec9 Fixed #29573 -- Added links in aggregation topic guide. 2018-09-10 09:53:19 -04:00
Tom Forbes b042ab8976 Fixed #29685 -- Added QuerySet.explain() to the database optimization docs. 2018-08-18 09:22:21 -04:00
Tim Graham cef8f6a61b Fixed #29591 -- Fixed numbering words in docs/topics/db/examples/many_to_many.txt. 2018-07-24 16:02:35 -04:00
Tim Graham 6b6bdfe25c Fixed IntegrityError in docs/topics/db/examples/many_to_one.txt. 2018-07-19 15:47:20 -04:00
Mattia Cattarinussi 2a0116266c Refs #29513 -- Linked the testing docs from the multi-db topic guide. 2018-06-28 20:29:07 -04:00
Tim Graham 7543ab1f8d Removed versionadded/changed annotations for 2.0. 2018-05-17 11:00:10 -04:00
Mariusz Felisiak 35319bf12c
Alphabetized imports in various docs.
Follow-up of d97cce3409 and 7d3fe36c62.
2018-05-12 19:37:42 +02:00
Stefan R. Filipek 9ec77f3d66 Fixed #29349 -- Doc'd the default behavior of router.allow_relation(). 2018-04-23 10:21:22 -04:00
Adnan Umer f2026ca5e2 Fixed #29337 -- Added __len__() & __bool__() to RawQuerySet. 2018-04-19 12:46:31 -04:00
Adnan Umer ec0319ff82 Fixed #29339 -- Added result caching to RawQuerySet. 2018-04-19 11:35:49 -04:00
Luoxzhg 99539ca319 Fixed typo in docs/topics/db/managers.txt. 2018-04-11 22:24:29 -04:00
Luoxzhg 9d7e2c7b44 Fixed mistakes in docs/topics/db/examples/many_to_one.txt. 2018-04-10 11:16:42 -04:00
Jezeniel Zapanta abe6c5defe Fixed #28514 -- Clarifed docs about idempotence of RelatedManager.add(). 2018-03-20 21:09:08 -04:00
Denis 1834490a0c Refs #11278 -- Clarified RelatedManager differences between reverse one-to-many and many-to-many relations. 2018-03-20 20:43:33 -04:00
ovalseven8 22bcd3a1d8 Fixed #29192 -- Corrected docs regarding overriding fields from abstract base classes. 2018-03-13 12:45:01 -04:00
Mariusz Felisiak 7c81b28ebc
Updated various links in docs to use HTTPS. 2018-01-07 14:28:41 +01:00
Jon Dufresne 7a6fbf36b1 Fixed #28853 -- Updated connection.cursor() uses to use a context manager. 2017-11-28 11:28:09 -05:00
Luke Plant e283c1a267 Linked to prefetch_related_objects func in DB optimization docs. 2017-11-23 21:26:39 +03:00
Tim Graham 327f0f37ce
Fixed #28770 -- Warned that quoting a placeholder in a raw SQL string is unsafe.
Thanks Hynek Cernoch for the report and review.
2017-11-07 13:07:12 -05:00
Tim Graham 00b93c2b1e Fixed typo in docs/topics/db/aggregation.txt. 2017-11-07 09:03:01 -05:00
Ville Skyttä 617686e226 Fixed 'a'/'an' mix-ups in docs. 2017-10-30 21:47:09 -04:00
LeeHanYeong 3ffbd54566 Removed incorrect reference to ModelChoiceField in Field.choices docs. 2017-10-13 10:37:04 -04:00
Tim Graham 27193aea00 Fixed #28584 -- Dropped support for SQLite < 3.7.15. 2017-10-03 10:42:18 -04:00