8000 Fix typos in docs (#6747) · cscutcher/django-rest-framework@72de94a · GitHub
[go: up one dir, main page]
Skip to content

Commit 72de94a

Browse files
minho42rpkilby
minho42
authored and
rpkilby
committed
Fix typos in docs (encode#6747)
1 parent 809a6ac commit 72de94a

File tree

7 files changed

+8
-8
lines changed

7 files changed

+8
-8
lines changed

‎docs/api-guide/caching.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Caching
22

3-
> A certain woman had a very sharp conciousness but almost no
3+
> A certain woman had a very sharp consciousness but almost no
44
> memory ... She remembered enough to work, and she worked hard.
55
> - Lydia Davis
66

‎docs/api-guide/fields.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ A field that ensures the input is a valid UUID string. The `to_internal_value` m
209209
**Signature:** `UUIDField(format='hex_verbose')`
210210

211211
- `format`: Determines the representation format of the uuid value
212-
- `'hex_verbose'` - The cannoncical hex representation, including hyphens: `"5ce0e9a5-5ffa-654b-cee0-1238041fb31a"`
212+
- `'hex_verbose'` - The canonical hex representation, including hyphens: `"5ce0e9a5-5ffa-654b-cee0-1238041fb31a"`
213213
- `'hex'` - The compact hex representation of the UUID, not including hyphens: `"5ce0e9a55ffa654bcee01238041fb31a"`
214214
- `'int'` - A 128 bit integer representation of the UUID: `"123456789012312313134124512351145145114"`
215215
- `'urn'` - RFC 4122 URN representation of the UUID: `"urn:uuid:5ce0e9a5-5ffa-654b-cee0-1238041fb31a"`

‎docs/api-guide/settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -404,7 +404,7 @@ This should be a function with the following signature:
404404

405405
If the view instance inherits `ViewSet`, it may have been initialized with several optional arguments:
406406

407-
* `name`: A name expliticly provided to a view in the viewset. Typically, this value should be used as-is when provided.
407+
* `name`: A name explicitly provided to a view in the viewset. Typically, this value should be used as-is when provided.
408408
* `suffix`: Text used when differentiating individual views in a viewset. This argument is mutually exclusive to `name`.
409409
* `detail`: Boolean that differentiates an individual view in a viewset as either being a 'list' or 'detail' view.
410410

‎docs/api-guide/throttling.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ If you need to strictly identify unique client IP addresses, you'll need to firs
7474

7575
It is important to understand that if you configure the `NUM_PROXIES` setting, then all clients behind a unique [NAT'd](https://en.wikipedia.org/wiki/Network_address_translation) gateway will be treated as a single client.
7676

77-
Further context on how the `X-Forwarded-For` header works, and identifying a remote client IP can be [found here][identifing-clients].
77+
Further context on how the `X-Forwarded-For` header works, and identifying a remote client IP can be [found here][identifying-clients].
7878

7979
## Setting up the cache
8080

@@ -194,6 +194,6 @@ The following is an example of a rate throttle, that will randomly throttle 1 in
194194

195195
[cite]: https://developer.twitter.com/en/docs/basics/rate-limiting
196196
[permissions]: permissions.md
197-
[identifing-clients]: http://oxpedia.org/wiki/index.php?title=AppSuite:Grizzly#Multiple_Proxies_in_front_of_the_cluster
197+
[identifying-clients]: http://oxpedia.org/wiki/index.php?title=AppSuite:Grizzly#Multiple_Proxies_in_front_of_the_cluster
198198
[cache-setting]: https://docs.djangoproject.com/en/stable/ref/settings/#caches
199199
[cache-docs]: https://docs.djangoproject.com/en/stable/topics/cache/#setting-up-the-cache

‎docs/community/3.6-announcement.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ REST framework's new API documentation supports a number of features:
6060
* Support for various authentication schemes.
6161
* Code snippets for the Python, JavaScript, and Command Line clients.
6262

63-
The `coreapi` library is required as a dependancy for the API docs. Make sure
63+
The `coreapi` library is required as a dependency for the API docs. Make sure
6464
to install the latest version (2.3.0 or above). The `pygments` and `markdown`
6565
libraries are optional but recommended.
6666

‎docs/community/release-notes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -321,7 +321,7 @@ Be sure to upgrade to Python 3 before upgrading to Django REST Framework 3.10.
321321
B7FF Note: `AutoSchema.__init__` now ensures `manual_fields` is a list.
322322
Previously may have been stored internally as `None`.
323323

324-
* Remove ulrparse compatability shim; use six instead [#5579][gh5579]
324+
* Remove ulrparse compatibility shim; use six instead [#5579][gh5579]
325325
* Drop compat wrapper for `TimeDelta.total_seconds()` [#5577][gh5577]
326326
* Clean up all whitespace throughout project [#5578][gh5578]
327327
* Compat cleanup [#5581][gh5581]

‎docs/community/third-party-packages.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ If you have an idea for a new feature please consider how it may be packaged as
2020

2121
You can use [this cookiecutter template][cookiecutter] for creating reusable Django REST Framework packages quickly. Cookiecutter creates projects from project templates. While optional, this cookiecutter template includes best practices from Django REST framework and other packages, as well as a Travis CI configuration, Tox configuration, and a sane setup.py for easy PyPI registration/distribution.
2222

23-
Note: Let us know if you have an alternate cookiecuter package so we can also link to it.
23+
Note: Let us know if you have an alternate cookiecutter package so we can also link to it.
2424

2525
#### Running the initial cookiecutter command
2626

0 commit comments

Comments
 (0)
0