From c94dbd7490e1808ab42f1b9ca97aeb3c109e4653 Mon Sep 17 00:00:00 2001 From: Min ho Kim Date: Wed, 19 Jun 2019 05:39:59 +1000 Subject: [PATCH] Fix typo in docs --- docs/api-guide/caching.md | 2 +- docs/api-guide/fields.md | 2 +- docs/api-guide/settings.md | 2 +- docs/api-guide/throttling.md | 4 ++-- docs/community/3.6-announcement.md | 2 +- docs/community/release-notes.md | 2 +- docs/community/third-party-packages.md | 2 +- 7 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/api-guide/caching.md b/docs/api-guide/caching.md index 5342345e4..502a0a9a9 100644 --- a/docs/api-guide/caching.md +++ b/docs/api-guide/caching.md @@ -1,6 +1,6 @@ # Caching -> A certain woman had a very sharp conciousness but almost no +> A certain woman had a very sharp consciousness but almost no > memory ... She remembered enough to work, and she worked hard. > - Lydia Davis diff --git a/docs/api-guide/fields.md b/docs/api-guide/fields.md index 64515f804..8a1e2a341 100644 --- a/docs/api-guide/fields.md +++ b/docs/api-guide/fields.md @@ -209,7 +209,7 @@ A field that ensures the input is a valid UUID string. The `to_internal_value` m **Signature:** `UUIDField(format='hex_verbose')` - `format`: Determines the representation format of the uuid value - - `'hex_verbose'` - The cannoncical hex representation, including hyphens: `"5ce0e9a5-5ffa-654b-cee0-1238041fb31a"` + - `'hex_verbose'` - The canonical hex representation, including hyphens: `"5ce0e9a5-5ffa-654b-cee0-1238041fb31a"` - `'hex'` - The compact hex representation of the UUID, not including hyphens: `"5ce0e9a55ffa654bcee01238041fb31a"` - `'int'` - A 128 bit integer representation of the UUID: `"123456789012312313134124512351145145114"` - `'urn'` - RFC 4122 URN representation of the UUID: `"urn:uuid:5ce0e9a5-5ffa-654b-cee0-1238041fb31a"` diff --git a/docs/api-guide/settings.md b/docs/api-guide/settings.md index 85e38185e..1b3cb9dcf 100644 --- a/docs/api-guide/settings.md +++ b/docs/api-guide/settings.md @@ -404,7 +404,7 @@ This should be a function with the following signature: If the view instance inherits `ViewSet`, it may have been initialized with several optional arguments: -* `name`: A name expliticly provided to a view in the viewset. Typically, this value should be used as-is when provided. +* `name`: A name explicitly provided to a view in the viewset. Typically, this value should be used as-is when provided. * `suffix`: Text used when differentiating individual views in a viewset. This argument is mutually exclusive to `name`. * `detail`: Boolean that differentiates an individual view in a viewset as either being a 'list' or 'detail' view. diff --git a/docs/api-guide/throttling.md b/docs/api-guide/throttling.md index dade47460..c2b06756a 100644 --- a/docs/api-guide/throttling.md +++ b/docs/api-guide/throttling.md @@ -74,7 +74,7 @@ If you need to strictly identify unique client IP addresses, you'll need to firs 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. -Further context on how the `X-Forwarded-For` header works, and identifying a remote client IP can be [found here][identifing-clients]. +Further context on how the `X-Forwarded-For` header works, and identifying a remote client IP can be [found here][identifying-clients]. ## Setting up the cache @@ -194,6 +194,6 @@ The following is an example of a rate throttle, that will randomly throttle 1 in [cite]: https://developer.twitter.com/en/docs/basics/rate-limiting [permissions]: permissions.md -[identifing-clients]: http://oxpedia.org/wiki/index.php?title=AppSuite:Grizzly#Multiple_Proxies_in_front_of_the_cluster +[identifying-clients]: http://oxpedia.org/wiki/index.php?title=AppSuite:Grizzly#Multiple_Proxies_in_front_of_the_cluster [cache-setting]: https://docs.djangoproject.com/en/stable/ref/settings/#caches [cache-docs]: https://docs.djangoproject.com/en/stable/topics/cache/#setting-up-the-cache diff --git a/docs/community/3.6-announcement.md b/docs/community/3.6-announcement.md index c6e8dfa06..c41ad8ecb 100644 --- a/docs/community/3.6-announcement.md +++ b/docs/community/3.6-announcement.md @@ -60,7 +60,7 @@ REST framework's new API documentation supports a number of features: * Support for various authentication schemes. * Code snippets for the Python, JavaScript, and Command Line clients. -The `coreapi` library is required as a dependancy for the API docs. Make sure +The `coreapi` library is required as a dependency for the API docs. Make sure to install the latest version (2.3.0 or above). The `pygments` and `markdown` libraries are optional but recommended. diff --git a/docs/community/release-notes.md b/docs/community/release-notes.md index 235447eee..4ed89d405 100644 --- a/docs/community/release-notes.md +++ b/docs/community/release-notes.md @@ -321,7 +321,7 @@ Be sure to upgrade to Python 3 before upgrading to Django REST Framework 3.10. Note: `AutoSchema.__init__` now ensures `manual_fields` is a list. Previously may have been stored internally as `None`. -* Remove ulrparse compatability shim; use six instead [#5579][gh5579] +* Remove ulrparse compatibility shim; use six instead [#5579][gh5579] * Drop compat wrapper for `TimeDelta.total_seconds()` [#5577][gh5577] * Clean up all whitespace throughout project [#5578][gh5578] * Compat cleanup [#5581][gh5581] diff --git a/docs/community/third-party-packages.md b/docs/community/third-party-packages.md index 135b600f9..1ead5ea67 100644 --- a/docs/community/third-party-packages.md +++ b/docs/community/third-party-packages.md @@ -20,7 +20,7 @@ If you have an idea for a new feature please consider how it may be packaged as 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. -Note: Let us know if you have an alternate cookiecuter package so we can also link to it. +Note: Let us know if you have an alternate cookiecutter package so we can also link to it. #### Running the initial cookiecutter command