Skip to content

Commit b090ae9

Browse files
meli-lewisrpkilby
authored andcommitted
Fix docs typos (#6195)
1 parent 5174a26 commit b090ae9

File tree

5 files changed

+8
-8
lines changed

5 files changed

+8
-8
lines changed

docs/api-guide/schemas.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ example above.
146146

147147
Automatic schema generation is provided by the `SchemaGenerator` class.
148148

149-
`SchemaGenerator` processes a list of routed URL pattterns and compiles the
149+
`SchemaGenerator` processes a list of routed URL patterns and compiles the
150150
appropriately structured Core API Document.
151151

152152
Basic usage is just to provide the title for your schema and call
@@ -818,7 +818,7 @@ A short description of the meaning and intended usage of the input field.
818818

819819
## drf-yasg - Yet Another Swagger Generator
820820

821-
[drf-yasg][drf-yasg] generates [OpenAPI][open-api] documents suitable for code generation - nested schemas,
821+
[drf-yasg][drf-yasg] generates [OpenAPI][open-api] documents suitable for code generation - nested schemas,
822822
named models, response bodies, enum/pattern/min/max validators, form parameters, etc.
823823

824824

docs/topics/documenting-your-api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ The built-in API documentation includes:
1616

1717
### Installation
1818

19-
The `coreapi` library is required as a dependancy for the API docs. Make sure
19+
The `coreapi` library is required as a dependency for the API docs. Make sure
2020
to install the latest version. The `pygments` and `markdown` libraries
2121
are optional but recommended.
2222

23-
To install the API documentation, you'll need to include it in your projects URLconf:
23+
To install the API documentation, you'll need to include it in your project's URLconf:
2424

2525
from rest_framework.documentation import include_docs_urls
2626

@@ -39,7 +39,7 @@ This will include two different views:
3939
**Note**: By default `include_docs_urls` configures the underlying `SchemaView` to generate _public_ schemas.
4040
This means that views will not be instantiated with a `request` instance. i.e. Inside the view `self.request` will be `None`.
4141

42-
To be compatible with this behaviour methods (such as `get_serializer` or `get_serializer_class` etc.) which inspect `self.request` or, particularly, `self.request.user` may need to be adjusted to handle this case.
42+
To be compatible with this behaviour, methods (such as `get_serializer` or `get_serializer_class` etc.) which inspect `self.request` or, particularly, `self.request.user` may need to be adjusted to handle this case.
4343

4444
You may ensure views are given a `request` instance by calling `include_docs_urls` with `public=False`:
4545

docs/topics/html-and-forms.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ REST framework is suitable for returning both API style responses, and regular H
44

55
## Rendering HTML
66

7-
In order to return HTML responses you'll need to either `TemplateHTMLRenderer`, or `StaticHTMLRenderer`.
7+
In order to return HTML responses you'll need to use either `TemplateHTMLRenderer`, or `StaticHTMLRenderer`.
88

99
The `TemplateHTMLRenderer` class expects the response to contain a dictionary of context data, and renders an HTML page based on a template that must be specified either in the view or on the response.
1010

docs/topics/internationalization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ REST framework includes these built-in translations both for standard exception
4343

4444
Note that the translations only apply to the error strings themselves. The format of error messages, and the keys of field names will remain the same. An example `400 Bad Request` response body might look like this:
4545

46-
{"detail": {"username": ["Esse campo deve ser unico."]}}
46+
{"detail": {"username": ["Esse campo deve ser único."]}}
4747

4848
If you want to use different string for parts of the response such as `detail` and `non_field_errors` then you can modify this behavior by using a [custom exception handler][custom-exception-handler].
4949

docs/topics/writable-nested-serializers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Nested data structures are easy enough to work with if they're read-only - simpl
2727
Some example output from our serializer.
2828

2929
{
30-
'title': 'Leaving party preperations',
30+
'title': 'Leaving party preparations',
3131
'items': [
3232
{'text': 'Compile playlist', 'is_completed': True},
3333
{'text': 'Send invites', 'is_completed': False},

0 commit comments

Comments
 (0)