Skip to content

Commit aba907f

Browse files
authored
Docs: Correct imports in code-blocks (#138)
* Correct imports in code-blocks * Update the CHANGELOG
1 parent f04c662 commit aba907f

File tree

2 files changed

+13
-10
lines changed

2 files changed

+13
-10
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ All notable changes to this project will be documented in this file.
44
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
55
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

7+
# [unreleased]
8+
- [PR 138](https://github.com/salesforce/django-declarative-apis/pull/138) Docs: Correct imports in code-blocks
9+
710
# [0.31.4] - 2023-10-12
811
- [PR 137](https://github.com/salesforce/django-declarative-apis/pull/137) Finalize endpoints before dispatching async tasks
912

django_declarative_apis/machinery/attributes.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ class RequestUrlField(TypedEndpointAttributeMixin, EndpointAttribute):
170170
171171
.. code-block:: python
172172
173-
from django-declarative-apis.machinery import url_field
173+
from django_declarative_apis.machinery import url_field
174174
175175
class TodoDeleteSingleTaskDefinition(
176176
TodoResourceMixin,
@@ -213,7 +213,7 @@ class RequestField(TypedEndpointAttributeMixin, RequestProperty):
213213
214214
.. code-block:: python
215215
216-
from django-declarative-apis.machinery import field
216+
from django_declarative_apis.machinery import field
217217
218218
task = field(required=True, type=str)
219219
@@ -253,7 +253,7 @@ class RequestField(TypedEndpointAttributeMixin, RequestProperty):
253253
254254
.. code-block:: python
255255
256-
from django-declarative-apis.machinery import field
256+
from django_declarative_apis.machinery import field
257257
258258
class FooDefinition(EndpointDefinition):
259259
foo = field(multivalued=True)
@@ -445,7 +445,7 @@ class EndpointTask(EndpointAttribute):
445445
446446
.. code-block:: python
447447
448-
from django-declarative-apis.machinery import task
448+
from django_declarative_apis.machinery import task
449449
450450
class SampleClass:
451451
# code
@@ -473,7 +473,7 @@ def sample_function():
473473
474474
.. code-block:: python
475475
476-
from django-declarative-apis.machinery import task
476+
from django_declarative_apis.machinery import task
477477
478478
class SampleEndpointDefinition:
479479
def is_authorized(self):
@@ -554,7 +554,7 @@ class DeferrableEndpointTask(EndpointTask):
554554
555555
.. code-block:: python
556556
557-
from django-declarative-apis.machinery import deferrable_task
557+
from django_declarative_apis.machinery import deferrable_task
558558
559559
class SampleClass:
560560
# code
@@ -610,7 +610,7 @@ def sample_method(arg):
610610
611611
.. code-block:: python
612612
613-
from django-declarative-apis.machinery import deferrable_task
613+
from django_declarative_apis.machinery import deferrable_task
614614
615615
class SampleClass:
616616
# code
@@ -821,7 +821,7 @@ class RequireOneAttribute(RequestFieldGroup):
821821
822822
.. code-block:: python
823823
824-
from django-declarative-apis.machinery import require_one
824+
from django_declarative_apis.machinery import require_one
825825
826826
sample_field_1 = field()
827827
sample_field_2 = field()
@@ -888,7 +888,7 @@ class Aggregate(EndpointAttribute):
888888
889889
.. code-block:: python
890890
891-
from django-declarative-apis.machinery import aggregate
891+
from django_declarative_apis.machinery import aggregate
892892
893893
class SampleClass:
894894
# code
@@ -910,7 +910,7 @@ def sample_function():
910910
911911
.. code-block:: python
912912
913-
from django-declarative-apis.machinery import aggregate
913+
from django_declarative_apis.machinery import aggregate
914914
915915
class SampleClass:
916916
user_id = url_field()

0 commit comments

Comments
 (0)