mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-10-04 07:46:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Refs #27656 -- Updated django.db docstring verbs according to PEP 257.

Browse source
This commit is contained in:
Anton Samarchyan 2017-01-24 18:04:12 -05:00 • committed by Tim Graham
parent d6e26e5b7c
commit 60e52a047e
63 changed files with 934 additions and 1266 deletions
Download patch file Download diff file Expand all files Collapse all files

26
django/db/models/options.py
View file

@ -284,7 +284,7 @@ class Options:
def setup_proxy(self, target):
"""
Does the internal setup so that the current model is a proxy for
Do the internal setup so that the current model is a proxy for
"target".
"""
self.pk = target._meta.pk
@ -315,11 +315,7 @@ class Options:
@property
def verbose_name_raw(self):
"""
There are a few places where the untranslated verbose name is needed
(so that we get the same value regardless of currently active
locale).
"""
"""Return the untranslated verbose name."""
with override(None):
return force_text(self.verbose_name)
@ -427,7 +423,7 @@ class Options:
@cached_property
def fields(self):
"""
Returns a list of all forward fields on the model and its parents,
Return a list of all forward fields on the model and its parents,
excluding ManyToManyFields.
Private API intended only to be used by Django itself; get_fields()
@ -461,7 +457,7 @@ class Options:
@cached_property
def concrete_fields(self):
"""
Returns a list of all concrete fields on the model and its parents.
Return a list of all concrete fields on the model and its parents.
Private API intended only to be used by Django itself; get_fields()
combined with filtering of field properties is the public API for
@ -474,7 +470,7 @@ class Options:
@cached_property
def local_concrete_fields(self):
"""
Returns a list of all concrete fields on the model.
Return a list of all concrete fields on the model.
Private API intended only to be used by Django itself; get_fields()
combined with filtering of field properties is the public API for
@ -487,7 +483,7 @@ class Options:
@cached_property
def many_to_many(self):
"""
Returns a list of all many to many fields on the model and its parents.
Return a list of all many to many fields on the model and its parents.
Private API intended only to be used by Django itself; get_fields()
combined with filtering of field properties is the public API for
@ -501,7 +497,7 @@ class Options:
@cached_property
def related_objects(self):
"""
Returns all related objects pointing to the current model. The related
Return all related objects pointing to the current model. The related
objects can come from a one-to-one, one-to-many, or many-to-many field
relation type.
@ -589,7 +585,7 @@ class Options:
def get_parent_list(self):
"""
Returns all the ancestors of this model as a list ordered by MRO.
Return all the ancestors of this model as a list ordered by MRO.
Useful for determining if something is an ancestor, regardless of lineage.
"""
result = OrderedSet(self.parents)
@ -600,12 +596,12 @@ class Options:
def get_ancestor_link(self, ancestor):
"""
Returns the field on the current model which points to the given
Return the field on the current model which points to the given
"ancestor". This is possible an indirect link (a pointer to a parent
model, which points, eventually, to the ancestor). Used when
constructing table joins for model inheritance.
Returns None if the model isn't an ancestor of this one.
Return None if the model isn't an ancestor of this one.
"""
if ancestor in self.parents:
return self.parents[ancestor]
@ -717,7 +713,7 @@ class Options:
def get_fields(self, include_parents=True, include_hidden=False):
"""
Returns a list of fields associated to the model. By default, includes
Return a list of fields associated to the model. By default, include
forward and reverse fields, fields derived from inheritance, but not
hidden fields. The returned fields can be changed using the parameters: