mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-30 21:16:26 +00:00
Code Issues 30 Releases Wiki Activity
31,460 Commits 28 Branches 426 Tags 622 MiB
a0f46ea7e8
Commit Graph

56 Commits

Author SHA1 Message Date
django-bot
62510f01e7 [4.2.x] Fixed #34140 -- Reformatted code blocks in docs with blacken-docs. 2023-03-01 13:39:03 +01:00
Carlton Gibson
b784768eef [4.2.x] Refs #34140 -- Applied rst code-block to non-Python examples. 
Thanks to J.V. Zammit, Paolo Melchiorre, and Mariusz Felisiak for
reviews.

Backport of 534ac48297 from main.
 2023-02-10 21:12:06 +01:00
Adam Johnson
59e503b670 Modernized custom manager example 
Since this example was added 15 years ago in a8ccdd0fcd, the ORM has gained the ability to do the `COUNT(*)` related query, so do it with the ORM to avoid misleading users that raw SQL is only supported from manager methods.
 2021-01-28 15:59:39 +01:00
Adam Johnson
d17b380653 Refs #30573 -- Rephrased "Of Course" and "Obvious(ly)" in documentation and comments. 2020-05-04 12:10:47 +02:00
Adam Radwon
a2f554249e
Fixed #27865 -- Adjusted docs example to avoid confusion with models.BaseManager. 2020-03-10 09:14:30 +01:00
Carlton Gibson
08a6215d33 Fixed #31342 -- Clarified docs about using base managers for related objects. 2020-03-06 11:08:08 +01:00
Adam Johnson
2ea3fb3e63 Removed "Don't do that" from docs and error messages. 
It's slightly aggressive and doesn't explain itself.
 2020-01-06 13:50:43 +01: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
Jon Dufresne
97d3321e89 Changed tuple choices to list in docs. 2019-05-15 14:31:42 +02:00
Luoxzhg
99539ca319 Fixed typo in docs/topics/db/managers.txt. 2018-04-11 22:24:29 -04:00
chillaranand
dc165ec8e5 Refs #23919 -- Replaced super(ClassName, self) with super() in docs. 2017-01-25 11:53:05 -05:00
Tim Graham
e27e4c0339 Removed versionadded/changed annotations for 1.10. 2017-01-17 20:52:05 -05:00
M Somerville
56c87b51ab Fixed typo in docs/topics/db/managers.txt. 2017-01-11 18:31:11 -05:00
Chris Jerdonek
ccf7adb064 Fixed #27172 -- Closed database cursor explicitly in two doc examples 2016-09-07 12:14:29 +02:00
Tim Graham
8fb53c50ce Fixed #19222 -- Documented that default managers aren't used for related queries. 2016-08-16 13:12:55 -04:00
Tim Graham
00551c3eff Fixed typo in docs/topics/db/managers.txt 2016-06-20 09:07:20 -04:00
Loïc Bistuer
ed0ff913c6 Fixed #10506, #13793, #14891, #25201 -- Introduced new APIs to specify models' default and base managers. 
This deprecates use_for_related_fields.

Old API:

class CustomManager(models.Model):
    use_for_related_fields = True

class Model(models.Model):
    custom_manager = CustomManager()

New API:

class Model(models.Model):
    custom_manager = CustomManager()

    class Meta:
        base_manager_name = 'custom_manager'

Refs #20932, #25897.

Thanks Carl Meyer for the guidance throughout this work.
Thanks Tim Graham for writing the docs.
 2016-05-17 12:07:22 +07:00
Loïc Bistuer
3a47d42fa3 Fixed #20932, #25897 -- Streamlined manager inheritance. 2016-05-17 02:29:22 +07:00
rowanv
a6ef025dfb Fixed #26124 -- Added missing code formatting to docs headers. 2016-02-01 10:42:05 -05:00
James Beith
e03798a4ae Fixed a typo in the managers docs. 2015-11-27 13:51:58 -05:00
Brendan Hayward
c9fb4f3c45 Fixed #25205 -- Removed doc references to deprecated GeoManager class. 2015-08-11 10:14:44 -04:00
Flavio Curella
c2e70f0265 Fixed #21127 -- Started deprecation toward requiring on_delete for ForeignKey/OneToOneField 2015-07-27 18:28:13 -04:00
Tim Graham
c79faae761 Removed versionadded/changed notes for 1.7. 2015-02-01 21:02:40 -05:00
Ismail Badawi
e501d4c505 Fixed #23597 -- Clarified the manager that {Single,Multiple}ObjectMixin.model uses. 2014-10-06 08:23:42 -04:00
Greg Brown
9e8658db51 Fixed typo in docs/topics/db/managers.txt 2014-09-29 07:45:28 -04:00
Éric Araujo
5842d8eba4 Removed non-existent reference to args/kwargs in manager docs. 2014-07-02 07:54:02 -04:00
Tim Graham
51c8045145 Removed versionadded/changed annotations for 1.6. 2014-03-24 11:42:56 -04:00
Loic Bistuer
f265c1ef13 Fixed gendered examples in the docs. 2014-02-05 14:58:50 -05:00
Frank Wiles
164df40501 Fixing manager documentation inaccuracy 2013-12-04 18:03:28 -06:00
Tim Graham
29255fcb4f Fixed some ReST errors regarding backticks 2013-08-15 07:14:10 -04:00
Dominic Rodger
c33d1ca1d9 Fixed #20852 - Fixed incorrectly generated left quotes in docs. 
Sphinx generates left single quotes for apostrophes after
code markup, when right single quotes are required. The
easiest way to fix this is just by inserting the unicode
character for a right single quote.

Instances of the problem were found by looking for
">‘" in the generated HTML.
 2013-08-06 07:13:17 -04:00
Loic Bistuer
31fadc1202 Fixed #20625 -- Chainable Manager/QuerySet methods. 
Additionally this patch solves the orthogonal problem that specialized
`QuerySet` like `ValuesQuerySet` didn't inherit from the current `QuerySet`
type. This wasn't an issue until now because we didn't officially support
custom `QuerySet` but it became necessary with the introduction of this new
feature.

Thanks aaugustin, akaariai, carljm, charettes, mjtamlyn, shaib and timgraham
for the reviews.
 2013-07-26 12:41:27 +03:00
Marc Egli
e4591debd1 Add missing imports and models to the examples in the the model layer documentation 2013-05-18 18:38:52 +02:00
Juan Catalano
78c842a323 Adapted uses of versionchanged/versionadded to the new form. 
Refs #20104.
 2013-04-20 17:18:35 +02:00
Tim Graham
c119d0f152 Fixed #20168 - Generalized a PostgreSQL specific database query in the docs. 
Thanks Russ for the suggestion.
 2013-03-31 03:40:44 -04:00
Nimesh Ghelani
485c024567 Fixed #20150 -- Fixed an error in manager doc example 2013-03-30 01:01:56 +05:30
Tim Graham
93cffc3b37 Added missing markup to docs. 2013-03-22 13:50:07 -04:00
Loic Bistuer
6983a1a540 Fixed #15363 -- Renamed and normalized to get_queryset the methods that return a QuerySet. 2013-03-08 10:11:45 -05:00
Russell Keith-Magee
1b646e656e Fixed #19384 -- Documented the behavior of custom managers on abstract models. 
This documents the behavior introduced by cc337a74, which is BACKWARDS
INCOMPATIBLE for any attempt to invoke a method on a manager using the
abstract class as the calling class (e.g., AbstractBase.objects.do_something())

Thanks to mhsparks for the report.
 2012-12-15 22:44:46 +08:00
Luke Plant
d1e5c55258 Fixed many more ReST indentation errors, somehow accidentally missed from [16955] 
git-svn-id: http://code.djangoproject.com/svn/django/trunk@16983 bcc190cf-cafb-0310-a4f2-bffc1f526a37
 2011-10-14 00:12:01 +00:00
Timo Graham
773e1717c0 Fixed #16145 - typo in manager docs; thanks leereilly. 
git-svn-id: http://code.djangoproject.com/svn/django/trunk@16324 bcc190cf-cafb-0310-a4f2-bffc1f526a37
 2011-06-04 14:38:45 +00:00
Russell Keith-Magee
1ca9e95d4e Fixed #15062 -- Documented the fact that managers must be able to be shallow copied. Thanks to Ian Clelland for the report, and Łukasz Rekucki for the help diagnosing the problem. 
git-svn-id: http://code.djangoproject.com/svn/django/trunk@15220 bcc190cf-cafb-0310-a4f2-bffc1f526a37
 2011-01-16 06:44:23 +00:00
Timo Graham
07ef43082d Fixed #15002 - Fix title casing to conform to style guidelines. thanks adamv. 
git-svn-id: http://code.djangoproject.com/svn/django/trunk@15135 bcc190cf-cafb-0310-a4f2-bffc1f526a37
 2011-01-03 13:29:17 +00:00
Jacob Kaplan-Moss
728effcfbd Fixed #14141: docs now use the :doc: construct for links between documents. 
Thanks, Ramiro Morales.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@13608 bcc190cf-cafb-0310-a4f2-bffc1f526a37
 2010-08-19 19:27:44 +00:00
Jacob Kaplan-Moss
099c6b8710 Fixed #13746: made the dumdata help message a bit clearer. Thanks, PaulM. 
git-svn-id: http://code.djangoproject.com/svn/django/trunk@13469 bcc190cf-cafb-0310-a4f2-bffc1f526a37
 2010-08-04 19:08:14 +00:00
Luke Plant
f7814cdfe6 Fixed #13035 - Incorrect documentation regarding admin and default managers 
Thanks to rasca for report and gabrielhurley for patch



git-svn-id: http://code.djangoproject.com/svn/django/trunk@12930 bcc190cf-cafb-0310-a4f2-bffc1f526a37
 2010-04-06 11:52:32 +00:00
Justin Bronn
459c71e332 Fixed #12930, #12832, #11538 -- Refactored and merged the GeoDjango documentation into the rest of the Django docs. 
git-svn-id: http://code.djangoproject.com/svn/django/trunk@12856 bcc190cf-cafb-0310-a4f2-bffc1f526a37
 2010-03-26 20:14:53 +00:00
Justin Bronn
9810178706 Fixed #12688 -- Removed typo in manager docs. Thanks, orokusaki for the report and timo for the patch. 
git-svn-id: http://code.djangoproject.com/svn/django/trunk@12485 bcc190cf-cafb-0310-a4f2-bffc1f526a37
 2010-02-22 02:35:47 +00:00
Jannis Leidel
9614b0190f Fixed #11794 - Typo in model manager documentation. Thanks, timo. 
git-svn-id: http://code.djangoproject.com/svn/django/trunk@12221 bcc190cf-cafb-0310-a4f2-bffc1f526a37
 2010-01-12 23:36:43 +00:00
Adrian Holovaty
34db1d6474 Fixed #11794 -- Removed an unnecessary literary flourish in docs/topics/db/managers.txt 
git-svn-id: http://code.djangoproject.com/svn/django/trunk@12189 bcc190cf-cafb-0310-a4f2-bffc1f526a37
 2010-01-10 18:51:32 +00:00