diff options
| author | Ed Henderson <ed@sharpertool.com> | 2016-06-02 12:56:13 -0700 |
|---|---|---|
| committer | Tim Graham <timograham@gmail.com> | 2016-06-03 11:44:34 -0400 |
| commit | 4a4d7f980e2a66756e1e424f7648dcd28ff765b7 (patch) | |
| tree | 3bb4acb494a41b3ef9ec59b9ab5670cbc46ff9ac /docs/ref | |
| parent | 38575b007a722d6af510ea46d46393a4cda9ca29 (diff) | |
Fixed #26021 -- Applied hanging indentation to docs.
Diffstat (limited to 'docs/ref')
| -rw-r--r-- | docs/ref/contrib/admin/index.txt | 33 | ||||
| -rw-r--r-- | docs/ref/contrib/gis/db-api.txt | 4 | ||||
| -rw-r--r-- | docs/ref/contrib/gis/tutorial.txt | 11 | ||||
| -rw-r--r-- | docs/ref/contrib/messages.txt | 9 | ||||
| -rw-r--r-- | docs/ref/contrib/sites.txt | 10 | ||||
| -rw-r--r-- | docs/ref/forms/fields.txt | 23 | ||||
| -rw-r--r-- | docs/ref/forms/widgets.txt | 7 | ||||
| -rw-r--r-- | docs/ref/models/expressions.txt | 3 | ||||
| -rw-r--r-- | docs/ref/models/fields.txt | 8 |
9 files changed, 67 insertions, 41 deletions
diff --git a/docs/ref/contrib/admin/index.txt b/docs/ref/contrib/admin/index.txt index bf2725f3ff..ac696656c2 100644 --- a/docs/ref/contrib/admin/index.txt +++ b/docs/ref/contrib/admin/index.txt @@ -615,10 +615,12 @@ subclass:: color_code = models.CharField(max_length=6) def colored_name(self): - return format_html('<span style="color: #{};">{} {}</span>', - self.color_code, - self.first_name, - self.last_name) + return format_html( + '<span style="color: #{};">{} {}</span>', + self.color_code, + self.first_name, + self.last_name, + ) class PersonAdmin(admin.ModelAdmin): list_display = ('first_name', 'last_name', 'colored_name') @@ -700,9 +702,11 @@ subclass:: color_code = models.CharField(max_length=6) def colored_first_name(self): - return format_html('<span style="color: #{};">{}</span>', - self.color_code, - self.first_name) + return format_html( + '<span style="color: #{};">{}</span>', + self.color_code, + self.first_name, + ) colored_first_name.admin_order_field = 'first_name' @@ -906,13 +910,11 @@ subclass:: def lookups(self, request, model_admin): if request.user.is_superuser: - return super(AuthDecadeBornListFilter, - self).lookups(request, model_admin) + return super(AuthDecadeBornListFilter, self).lookups(request, model_admin) def queryset(self, request, queryset): if request.user.is_superuser: - return super(AuthDecadeBornListFilter, - self).queryset(request, queryset) + return super(AuthDecadeBornListFilter, self).queryset(request, queryset) Also as a convenience, the ``ModelAdmin`` object is passed to the ``lookups`` method, for example if you want to base the @@ -1268,8 +1270,8 @@ subclass:: class PersonAdmin(admin.ModelAdmin): def view_on_site(self, obj): - return 'https://example.com' + reverse('person-detail', - kwargs={'slug': obj.slug}) + url = reverse('person-detail', kwargs={'slug': obj.slug}) + return 'https://example.com' + url Custom template options ~~~~~~~~~~~~~~~~~~~~~~~ @@ -1875,8 +1877,9 @@ provided some extra mapping data that would not otherwise be available:: def change_view(self, request, object_id, form_url='', extra_context=None): extra_context = extra_context or {} extra_context['osm_data'] = self.get_osm_info() - return super(MyModelAdmin, self).change_view(request, object_id, - form_url, extra_context=extra_context) + return super(MyModelAdmin, self).change_view( + request, object_id, form_url, extra_context=extra_context, + ) These views return :class:`~django.template.response.TemplateResponse` instances which allow you to easily customize the response data before diff --git a/docs/ref/contrib/gis/db-api.txt b/docs/ref/contrib/gis/db-api.txt index 483a28c08a..3db8f426aa 100644 --- a/docs/ref/contrib/gis/db-api.txt +++ b/docs/ref/contrib/gis/db-api.txt @@ -120,7 +120,7 @@ raster models:: >>> from django.contrib.gis.gdal import GDALRaster >>> rast = GDALRaster({'width': 10, 'height': 10, 'name': 'Canyon', 'srid': 4326, - ... 'scale': [0.1, -0.1]'bands': [{"data": range(100)}]} + ... 'scale': [0.1, -0.1], 'bands': [{"data": range(100)}]}) >>> dem = Elevation(name='Canyon', rast=rast) >>> dem.save() @@ -129,7 +129,7 @@ Note that this equivalent to:: >>> dem = Elevation.objects.create( ... name='Canyon', ... rast={'width': 10, 'height': 10, 'name': 'Canyon', 'srid': 4326, - ... 'scale': [0.1, -0.1]'bands': [{"data": range(100)}]} + ... 'scale': [0.1, -0.1], 'bands': [{"data": range(100)}]}, ... ) .. _spatial-lookups-intro: diff --git a/docs/ref/contrib/gis/tutorial.txt b/docs/ref/contrib/gis/tutorial.txt index 8f597df9fb..5d753a327e 100644 --- a/docs/ref/contrib/gis/tutorial.txt +++ b/docs/ref/contrib/gis/tutorial.txt @@ -452,12 +452,15 @@ with the following code:: 'mpoly' : 'MULTIPOLYGON', } - world_shp = os.path.abspath(os.path.join(os.path.dirname(__file__), 'data', 'TM_WORLD_BORDERS-0.3.shp')) + world_shp = os.path.abspath( + os.path.join(os.path.dirname(__file__), 'data', 'TM_WORLD_BORDERS-0.3.shp'), + ) def run(verbose=True): - lm = LayerMapping(WorldBorder, world_shp, world_mapping, - transform=False, encoding='iso-8859-1') - + lm = LayerMapping( + WorldBorder, world_shp, world_mapping, + transform=False, encoding='iso-8859-1', + ) lm.save(strict=True, verbose=verbose) A few notes about what's going on: diff --git a/docs/ref/contrib/messages.txt b/docs/ref/contrib/messages.txt index 414cf21116..3343707d69 100644 --- a/docs/ref/contrib/messages.txt +++ b/docs/ref/contrib/messages.txt @@ -320,8 +320,7 @@ Adding extra message tags For more direct control over message tags, you can optionally provide a string containing extra tags to any of the add methods:: - messages.add_message(request, messages.INFO, 'Over 9000!', - extra_tags='dragonball') + messages.add_message(request, messages.INFO, 'Over 9000!', extra_tags='dragonball') messages.error(request, 'Email box full', extra_tags='email') Extra tags are added before the default tag for that level and are space @@ -336,8 +335,10 @@ if they don't want to, you may pass an additional keyword argument ``fail_silently=True`` to any of the ``add_message`` family of methods. For example:: - messages.add_message(request, messages.SUCCESS, 'Profile details updated.', - fail_silently=True) + messages.add_message( + request, messages.SUCCESS, 'Profile details updated.', + fail_silently=True, + ) messages.info(request, 'Hello world.', fail_silently=True) .. note:: diff --git a/docs/ref/contrib/sites.txt b/docs/ref/contrib/sites.txt index 2ff5fc6490..82fa1e41d5 100644 --- a/docs/ref/contrib/sites.txt +++ b/docs/ref/contrib/sites.txt @@ -197,10 +197,14 @@ Here's an example of what the form-handling view looks like:: # ... current_site = get_current_site(request) - send_mail('Thanks for subscribing to %s alerts' % current_site.name, - 'Thanks for your subscription. We appreciate it.\n\n-The %s team.' % current_site.name, + send_mail( + 'Thanks for subscribing to %s alerts' % current_site.name, + 'Thanks for your subscription. We appreciate it.\n\n-The %s team.' % ( + current_site.name, + ), 'editor@%s' % current_site.domain, - [user.email]) + [user.email], + ) # ... diff --git a/docs/ref/forms/fields.txt b/docs/ref/forms/fields.txt index 13b937b117..8d6fc98f22 100644 --- a/docs/ref/forms/fields.txt +++ b/docs/ref/forms/fields.txt @@ -998,16 +998,25 @@ Slightly complex built-in ``Field`` classes } # Or define a different message for each field. fields = ( - CharField(error_messages={'incomplete': 'Enter a country calling code.'}, - validators=[RegexValidator(r'^[0-9]+$', 'Enter a valid country calling code.')]), - CharField(error_messages={'incomplete': 'Enter a phone number.'}, - validators=[RegexValidator(r'^[0-9]+$', 'Enter a valid phone number.')]), - CharField(validators=[RegexValidator(r'^[0-9]+$', 'Enter a valid extension.')], - required=False), + CharField( + error_messages={'incomplete': 'Enter a country calling code.'}, + validators=[ + RegexValidator(r'^[0-9]+$', 'Enter a valid country calling code.'), + ], + ), + CharField( + error_messages={'incomplete': 'Enter a phone number.'}, + validators=[RegexValidator(r'^[0-9]+$', 'Enter a valid phone number.')], + ), + CharField( + validators=[RegexValidator(r'^[0-9]+$', 'Enter a valid extension.')], + required=False, + ), ) super(PhoneField, self).__init__( error_messages=error_messages, fields=fields, - require_all_fields=False, *args, **kwargs) + require_all_fields=False, *args, **kwargs + ) .. attribute:: MultiValueField.widget diff --git a/docs/ref/forms/widgets.txt b/docs/ref/forms/widgets.txt index 850905fb40..6a8cdf3c70 100644 --- a/docs/ref/forms/widgets.txt +++ b/docs/ref/forms/widgets.txt @@ -62,8 +62,11 @@ widget on the field. In the following example, the class SimpleForm(forms.Form): birth_year = forms.DateField(widget=forms.SelectDateWidget(years=BIRTH_YEAR_CHOICES)) - favorite_colors = forms.MultipleChoiceField(required=False, - widget=forms.CheckboxSelectMultiple, choices=FAVORITE_COLORS_CHOICES) + favorite_colors = forms.MultipleChoiceField( + required=False, + widget=forms.CheckboxSelectMultiple, + choices=FAVORITE_COLORS_CHOICES, + ) See the :ref:`built-in widgets` for more information about which widgets are available and which arguments they accept. diff --git a/docs/ref/models/expressions.txt b/docs/ref/models/expressions.txt index b091cf9fc8..6b1df0d937 100644 --- a/docs/ref/models/expressions.txt +++ b/docs/ref/models/expressions.txt @@ -371,7 +371,8 @@ SQL that is generated. Here's a brief example:: expression, distinct='DISTINCT ' if distinct else '', output_field=IntegerField(), - **extra) + **extra + ) ``Value()`` expressions diff --git a/docs/ref/models/fields.txt b/docs/ref/models/fields.txt index 35871a6cd1..a56c445c31 100644 --- a/docs/ref/models/fields.txt +++ b/docs/ref/models/fields.txt @@ -112,9 +112,11 @@ define a suitably-named constant for each value:: (JUNIOR, 'Junior'), (SENIOR, 'Senior'), ) - year_in_school = models.CharField(max_length=2, - choices=YEAR_IN_SCHOOL_CHOICES, - default=FRESHMAN) + year_in_school = models.CharField( + max_length=2, + choices=YEAR_IN_SCHOOL_CHOICES, + default=FRESHMAN, + ) def is_upperclass(self): return self.year_in_school in (self.JUNIOR, self.SENIOR) |
