summaryrefslogtreecommitdiff
path: root/django/apps/config.py
diff options
context:
space:
mode:
authorAnton Samarchyan <anton.samarchyan@savoirfairelinux.com>2017-01-24 15:37:33 -0500
committerTim Graham <timograham@gmail.com>2017-03-04 10:02:06 -0500
commit86de930f413e0ad902e11d78ac988e6743202ea6 (patch)
tree790dcc4c38125b619ffee76b5531155d0d8232f4 /django/apps/config.py
parent6ae1b04fb584db0fdb22b8e287784c4ed3ac62ac (diff)
Refs #27656 -- Updated remaining docstring verbs according to PEP 257.
Diffstat (limited to 'django/apps/config.py')
-rw-r--r--django/apps/config.py22
1 files changed, 10 insertions, 12 deletions
diff --git a/django/apps/config.py b/django/apps/config.py
index 4845557051..157fda7238 100644
--- a/django/apps/config.py
+++ b/django/apps/config.py
@@ -8,15 +8,13 @@ MODELS_MODULE_NAME = 'models'
class AppConfig:
- """
- Class representing a Django application and its configuration.
- """
+ """Class representing a Django application and its configuration."""
def __init__(self, app_name, app_module):
- # Full Python path to the application eg. 'django.contrib.admin'.
+ # Full Python path to the application e.g. 'django.contrib.admin'.
self.name = app_name
- # Root module for the application eg. <module 'django.contrib.admin'
+ # Root module for the application e.g. <module 'django.contrib.admin'
# from 'django/contrib/admin/__init__.py'>.
self.module = app_module
@@ -27,21 +25,21 @@ class AppConfig:
# The following attributes could be defined at the class level in a
# subclass, hence the test-and-set pattern.
- # Last component of the Python path to the application eg. 'admin'.
+ # Last component of the Python path to the application e.g. 'admin'.
# This value must be unique across a Django project.
if not hasattr(self, 'label'):
self.label = app_name.rpartition(".")[2]
- # Human-readable name for the application eg. "Admin".
+ # Human-readable name for the application e.g. "Admin".
if not hasattr(self, 'verbose_name'):
self.verbose_name = self.label.title()
- # Filesystem path to the application directory eg.
+ # Filesystem path to the application directory e.g.
# '/path/to/django/contrib/admin'.
if not hasattr(self, 'path'):
self.path = self._path_from_module(app_module)
- # Module containing models eg. <module 'django.contrib.admin.models'
+ # Module containing models e.g. <module 'django.contrib.admin.models'
# from 'django/contrib/admin/models.py'>. Set by import_models().
# None if the application doesn't have a models module.
self.models_module = None
@@ -155,9 +153,9 @@ class AppConfig:
def get_model(self, model_name, require_ready=True):
"""
- Returns the model with the given case-insensitive model_name.
+ Return the model with the given case-insensitive model_name.
- Raises LookupError if no model exists with this name.
+ Raise LookupError if no model exists with this name.
"""
if require_ready:
self.apps.check_models_ready()
@@ -171,7 +169,7 @@ class AppConfig:
def get_models(self, include_auto_created=False, include_swapped=False):
"""
- Returns an iterable of models.
+ Return an iterable of models.
By default, the following models aren't included: