Skip to content

Commit cf2d264

Browse files
authored
chore: Fix a few typos (#102)
* Fix a few typos * Fix a weird README formatting issue * Fix typos
1 parent b98a810 commit cf2d264

File tree

6 files changed

+8
-7
lines changed

6 files changed

+8
-7
lines changed

CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
66

77
# [unreleased] - XXXX-XX-XX
88
### Added
9-
- [PR 100](https://github.com/salesforce/django-declarative-apis/pull/100) Improve `errors.py`
9+
- [PR 102](https://github.com/salesforce/django-declarative-apis/pull/102) Fix typos in docs and tests
1010
- [PR 101](https://github.com/salesforce/django-declarative-apis/pull/101) Allow Pydantic models as field types
11+
- [PR 100](https://github.com/salesforce/django-declarative-apis/pull/100) Improve `errors.py`
1112

1213
# [0.23.1] - 2022-05-17
1314
### Fixed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ django-declarative-apis is a framework built on top of Django aimed at teams imp
1010
- Define model-bound and unbound resource endpoints with a consistent interface
1111
- OAuth 1.0a authentication out of the box
1212
- Define resource and endpoint-bound tasks, promoting modularity
13-
\* Define synchronous and asynchronous tasks (asynchronous tasks implemented with Celery)
13+
- Define synchronous and asynchronous tasks (asynchronous tasks implemented with Celery)
1414
- Separation of concerns between request body processing and business logic
1515

1616

django_declarative_apis/machinery/attributes.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ class RequestField(TypedEndpointAttributeMixin, RequestProperty):
236236
:param description: Describes the purpose of the field. Defaults to :code:`None`.
237237
:type description: optional
238238
239-
:param multivalued: Allows a field to to be specified multiple times in the request.
239+
:param multivalued: Allows a field to be specified multiple times in the request.
240240
With multivalued set to True, the EndpointHandler will receive a list of values
241241
instead of a single value. Defaults to :code:`False`.
242242
:type multivalued: optional
@@ -258,7 +258,7 @@ class RequestField(TypedEndpointAttributeMixin, RequestProperty):
258258
class FooDefinition(EndpointDefinition):
259259
foo = field(multivalued=True)
260260
261-
In the :code:`EndpointDefintion`, :code:`self.foo` would be equal to ['bar1',
261+
In the :code:`EndpointDefinition`, :code:`self.foo` would be equal to ['bar1',
262262
'bar2']
263263
264264
"""

docs/source/filters.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Filters can be defined in four places:
8181
8282
3. ``@endpoint_resource``
8383

84-
**Optional |** Defines filters for a class and can be used interchangeably with response filter. To implement, set :code:`filter=<filter>` in an argument to the :code:`@endpoint_resource` decorator.
84+
**Optional |** Defines filters for a class and can be used interchangeably with :code:`response_filter`. To implement, set :code:`filter=<filter>` in an argument to the :code:`@endpoint_resource` decorator.
8585

8686
**Default Value |** :code:`None`
8787

tests/machinery/test_errors.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
from django_declarative_apis.machinery import errors
55

66

7-
class ErrorTestCast(django.test.TestCase):
7+
class ErrorTestCase(django.test.TestCase):
88
def test_apierror_tuple(self):
99
test_code, test_message = test_tuple = errors.HTTPS_REQUIRED
1010
err = errors.ApiError(error_tuple=test_tuple)

tests/resources/test_resource.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ def test_init_unset_authentication_handlers(self):
122122
def test_init_uncallable_handler(self):
123123
try:
124124
resource.Resource("not callable")
125-
self.fail("should have faileid")
125+
self.fail("should have failed")
126126
except AttributeError as err:
127127
self.assertEqual(str(err), "Handler not callable.")
128128

0 commit comments

Comments
 (0)