Skip to content

Commit c9e7b68

Browse files
minor documentation improvements and fixes (#8903)
* minor documentation improvements and fixes * Update docs/api-guide/fields.md --------- Co-authored-by: Tom Christie <[email protected]>
1 parent b7523f4 commit c9e7b68

File tree

7 files changed

+13
-13
lines changed

7 files changed

+13
-13
lines changed

docs/api-guide/authentication.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -414,7 +414,7 @@ The [HawkREST][hawkrest] library builds on the [Mohawk][mohawk] library to let y
414414

415415
## HTTP Signature Authentication
416416

417-
HTTP Signature (currently a [IETF draft][http-signature-ietf-draft]) provides a way to achieve origin authentication and message integrity for HTTP messages. Similar to [Amazon's HTTP Signature scheme][amazon-http-signature], used by many of its services, it permits stateless, per-request authentication. [Elvio Toccalino][etoccalino] maintains the [djangorestframework-httpsignature][djangorestframework-httpsignature] (outdated) package which provides an easy to use HTTP Signature Authentication mechanism. You can use the updated fork version of [djangorestframework-httpsignature][djangorestframework-httpsignature], which is [drf-httpsig][drf-httpsig].
417+
HTTP Signature (currently a [IETF draft][http-signature-ietf-draft]) provides a way to achieve origin authentication and message integrity for HTTP messages. Similar to [Amazon's HTTP Signature scheme][amazon-http-signature], used by many of its services, it permits stateless, per-request authentication. [Elvio Toccalino][etoccalino] maintains the [djangorestframework-httpsignature][djangorestframework-httpsignature] (outdated) package which provides an easy-to-use HTTP Signature Authentication mechanism. You can use the updated fork version of [djangorestframework-httpsignature][djangorestframework-httpsignature], which is [drf-httpsig][drf-httpsig].
418418

419419
## Djoser
420420

docs/api-guide/exceptions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ By default this exception results in a response with the HTTP status code "403 F
179179

180180
**Signature:** `NotFound(detail=None, code=None)`
181181

182-
Raised when a resource does not exists at the given URL. This exception is equivalent to the standard `Http404` Django exception.
182+
Raised when a resource does not exist at the given URL. This exception is equivalent to the standard `Http404` Django exception.
183183

184184
By default this exception results in a response with the HTTP status code "404 Not Found".
185185

docs/api-guide/fields.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@ Corresponds to `django.forms.fields.IPAddressField` and `django.forms.fields.Gen
251251

252252
**Signature**: `IPAddressField(protocol='both', unpack_ipv4=False, **options)`
253253

254-
* `protocol` Limits valid inputs to the specified protocol. Accepted values are 'both' (default), 'IPv4' or 'IPv6'. Matching is case insensitive.
254+
* `protocol` Limits valid inputs to the specified protocol. Accepted values are 'both' (default), 'IPv4' or 'IPv6'. Matching is case-insensitive.
255255
* `unpack_ipv4` Unpacks IPv4 mapped addresses like ::ffff:192.0.2.1. If this option is enabled that address would be unpacked to 192.0.2.1. Default is disabled. Can only be used when protocol is set to 'both'.
256256

257257
---
@@ -294,7 +294,7 @@ Corresponds to `django.db.models.fields.DecimalField`.
294294
* `max_value` Validate that the number provided is no greater than this value.
295295
* `min_value` Validate that the number provided is no less than this value.
296296
* `localize` Set to `True` to enable localization of input and output based on the current locale. This will also force `coerce_to_string` to `True`. Defaults to `False`. Note that data formatting is enabled if you have set `USE_L10N=True` in your settings file.
297-
* `rounding` Sets the rounding mode used when quantising to the configured precision. Valid values are [`decimal` module rounding modes][python-decimal-rounding-modes]. Defaults to `None`.
297+
* `rounding` Sets the rounding mode used when quantizing to the configured precision. Valid values are [`decimal` module rounding modes][python-decimal-rounding-modes]. Defaults to `None`.
298298
* `normalize_output` Will normalize the decimal value when serialized. This will strip all trailing zeroes and change the value's precision to the minimum required precision to be able to represent the value without loosing data. Defaults to `False`.
299299

300300
#### Example usage
@@ -321,13 +321,13 @@ Corresponds to `django.db.models.fields.DateTimeField`.
321321

322322
* `format` - A string representing the output format. If not specified, this defaults to the same value as the `DATETIME_FORMAT` settings key, which will be `'iso-8601'` unless set. Setting to a format string indicates that `to_representation` return values should be coerced to string output. Format strings are described below. Setting this value to `None` indicates that Python `datetime` objects should be returned by `to_representation`. In this case the datetime encoding will be determined by the renderer.
323323
* `input_formats` - A list of strings representing the input formats which may be used to parse the date. If not specified, the `DATETIME_INPUT_FORMATS` setting will be used, which defaults to `['iso-8601']`.
324-
* `default_timezone` - A `tzinfo` subclass (`zoneinfo` or `pytz`) prepresenting the timezone. If not specified and the `USE_TZ` setting is enabled, this defaults to the [current timezone][django-current-timezone]. If `USE_TZ` is disabled, then datetime objects will be naive.
324+
* `default_timezone` - A `tzinfo` subclass (`zoneinfo` or `pytz`) representing the timezone. If not specified and the `USE_TZ` setting is enabled, this defaults to the [current timezone][django-current-timezone]. If `USE_TZ` is disabled, then datetime objects will be naive.
325325

326326
#### `DateTimeField` format strings.
327327

328328
Format strings may either be [Python strftime formats][strftime] which explicitly specify the format, or the special string `'iso-8601'`, which indicates that [ISO 8601][iso8601] style datetimes should be used. (eg `'2013-01-29T12:34:56.000000Z'`)
329329

330-
When a value of `None` is used for the format `datetime` objects will be returned by `to_representation` and the final output representation will determined by the renderer class.
330+
When a value of `None` is used for the format `datetime` objects will be returned by `to_representation` and the final output representation will be determined by the renderer class.
331331

332332
#### `auto_now` and `auto_now_add` model fields.
333333

docs/api-guide/filtering.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,7 @@ The `OrderingFilter` class supports simple query parameter controlled ordering o
253253

254254
![Ordering Filter](../img/ordering-filter.png)
255255

256-
By default, the query parameter is named `'ordering'`, but this may by overridden with the `ORDERING_PARAM` setting.
256+
By default, the query parameter is named `'ordering'`, but this may be overridden with the `ORDERING_PARAM` setting.
257257

258258
For example, to order users by username:
259259

@@ -269,7 +269,7 @@ Multiple orderings may also be specified:
269269

270270
### Specifying which fields may be ordered against
271271

272-
It's recommended that you explicitly specify which fields the API should allowing in the ordering filter. You can do this by setting an `ordering_fields` attribute on the view, like so:
272+
It's recommended that you explicitly specify which fields the API should allow in the ordering filter. You can do this by setting an `ordering_fields` attribute on the view, like so:
273273

274274
class UserListView(generics.ListAPIView):
275275
queryset = User.objects.all()

docs/api-guide/pagination.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@ Suppose we want to replace the default pagination output style with a modified f
240240
'results': data
241241
})
242242

243-
We'd then need to setup the custom class in our configuration:
243+
We'd then need to set up the custom class in our configuration:
244244

245245
REST_FRAMEWORK = {
246246
'DEFAULT_PAGINATION_CLASS': 'my_project.apps.core.pagination.CustomPagination',
@@ -262,7 +262,7 @@ API responses for list endpoints will now include a `Link` header, instead of in
262262

263263
![Link Header][link-header]
264264

265-
*A custom pagination style, using the 'Link' header'*
265+
*A custom pagination style, using the 'Link' header*
266266

267267
---
268268

docs/api-guide/parsers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ sending more complex data than simple forms
1111
>
1212
> &mdash; Malcom Tredinnick, [Django developers group][cite]
1313
14-
REST framework includes a number of built in Parser classes, that allow you to accept requests with various media types. There is also support for defining your own custom parsers, which gives you the flexibility to design the media types that your API accepts.
14+
REST framework includes a number of built-in Parser classes, that allow you to accept requests with various media types. There is also support for defining your own custom parsers, which gives you the flexibility to design the media types that your API accepts.
1515

1616
## How the parser is determined
1717

docs/api-guide/serializers.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -758,11 +758,11 @@ This is `True` by default, but can be set to `False` if you want to disallow emp
758758

759759
### `max_length`
760760

761-
This is `None` by default, but can be set to a positive integer if you want to validates that the list contains no more than this number of elements.
761+
This is `None` by default, but can be set to a positive integer if you want to validate that the list contains no more than this number of elements.
762762

763763
### `min_length`
764764

765-
This is `None` by default, but can be set to a positive integer if you want to validates that the list contains no fewer than this number of elements.
765+
This is `None` by default, but can be set to a positive integer if you want to validate that the list contains no fewer than this number of elements.
766766

767767
### Customizing `ListSerializer` behavior
768768

0 commit comments

Comments
 (0)