Skip to content

Commit 07841d0

Browse files
authored
docs: Make the spelling of "modelling" consistent (#4039)
1 parent f393a17 commit 07841d0

File tree

9 files changed

+20
-20
lines changed

9 files changed

+20
-20
lines changed

docs/tutorials/repository-tutorial/01-modeling-and-features.rst renamed to docs/tutorials/repository-tutorial/01-modelling-and-features.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
Introduction to Database Modeling and Repository Features
2-
---------------------------------------------------------
1+
Introduction to Database Modelling and Repository Features
2+
----------------------------------------------------------
33
In this tutorial, we will cover the integrated repository features in Litestar, starting
4-
with database modeling using the included SQLAlchemy declarative model helpers. These
4+
with database modelling using the included SQLAlchemy declarative model helpers. These
55
are a series of classes and mixins that incorporate commonly used functions/column types
66
to make working with models easier.
77

88
.. tip:: The full code for this tutorial can be found below in the :ref:`Full Code <01-repo-full-code>` section.
99

10-
Modeling
11-
--------
10+
Modelling
11+
---------
1212

1313
We'll begin by modelling the entities and relationships between authors and books.
1414
We'll start by creating the ``Author`` table, utilizing the

docs/tutorials/repository-tutorial/02-repository-introduction.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Interacting with repositories
22
-----------------------------
3-
Now that we've covered the modeling basics, we are able to create our first repository
3+
Now that we've covered the modelling basics, we are able to create our first repository
44
class. The repository classes include all of the standard CRUD operations as well as a
55
few advanced features such as pagination, filtering and bulk operations.
66

docs/tutorials/repository-tutorial/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ databases a breeze. Lets get started!
1717
.. toctree::
1818
:hidden:
1919

20-
01-modeling-and-features
20+
01-modelling-and-features
2121
02-repository-introduction
2222
03-repository-controller
2323
04-repository-other

litestar/app.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -309,8 +309,8 @@ def __init__(
309309
security: A sequence of dicts that will be added to the schema of all route handlers in the application.
310310
See
311311
:data:`SecurityRequirement <.openapi.spec.SecurityRequirement>` for details.
312-
signature_namespace: A mapping of names to types for use in forward reference resolution during signature modeling.
313-
signature_types: A sequence of types for use in forward reference resolution during signature modeling.
312+
signature_namespace: A mapping of names to types for use in forward reference resolution during signature modelling.
313+
signature_types: A sequence of types for use in forward reference resolution during signature modelling.
314314
These types will be added to the signature namespace using their ``__name__`` attribute.
315315
state: An optional :class:`State <.datastructures.State>` for application state.
316316
static_files_config: A sequence of :class:`StaticFilesConfig <.static_files.StaticFilesConfig>`

litestar/config/app.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -193,9 +193,9 @@ class AppConfig:
193193
:data:`SecurityRequirement <.openapi.spec.SecurityRequirement>` for details.
194194
"""
195195
signature_namespace: dict[str, Any] = field(default_factory=dict)
196-
"""A mapping of names to types for use in forward reference resolution during signature modeling."""
196+
"""A mapping of names to types for use in forward reference resolution during signature modelling."""
197197
signature_types: list[Any] = field(default_factory=list)
198-
"""A sequence of types for use in forward reference resolution during signature modeling.
198+
"""A sequence of types for use in forward reference resolution during signature modelling.
199199
200200
These types will be added to the signature namespace using their ``__name__`` attribute.
201201
"""

litestar/controller.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -159,9 +159,9 @@ class Controller:
159159
security: Sequence[SecurityRequirement] | None
160160
"""A sequence of dictionaries that to the schema of all route handlers under the controller."""
161161
signature_namespace: dict[str, Any]
162-
"""A mapping of names to types for use in forward reference resolution during signature modeling."""
162+
"""A mapping of names to types for use in forward reference resolution during signature modelling."""
163163
signature_types: Sequence[Any]
164-
"""A sequence of types for use in forward reference resolution during signature modeling.
164+
"""A sequence of types for use in forward reference resolution during signature modelling.
165165
166166
These types will be added to the signature namespace using their ``__name__`` attribute.
167167
"""

litestar/handlers/base.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ def __init__(
113113
outbound response data.
114114
signature_namespace: A mapping of names to types for use in forward reference resolution during signature
115115
modelling.
116-
signature_types: A sequence of types for use in forward reference resolution during signature modeling.
116+
signature_types: A sequence of types for use in forward reference resolution during signature modelling.
117117
These types will be added to the signature namespace using their ``__name__`` attribute.
118118
type_decoders: A sequence of tuples, each composed of a predicate testing for type identity and a msgspec hook for deserialization.
119119
type_encoders: A mapping of types to callables that transform them into types supported for serialization.

litestar/router.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -160,8 +160,8 @@ def __init__(
160160
security: A sequence of dicts that will be added to the schema of all route handlers in the application.
161161
See :data:`SecurityRequirement <.openapi.spec.SecurityRequirement>`
162162
for details.
163-
signature_namespace: A mapping of names to types for use in forward reference resolution during signature modeling.
164-
signature_types: A sequence of types for use in forward reference resolution during signature modeling.
163+
signature_namespace: A mapping of names to types for use in forward reference resolution during signature modelling.
164+
signature_types: A sequence of types for use in forward reference resolution during signature modelling.
165165
These types will be added to the signature namespace using their ``__name__`` attribute.
166166
tags: A sequence of string tags that will be appended to the schema of all route handlers under the
167167
application.

litestar/testing/helpers.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -222,8 +222,8 @@ def test_my_handler() -> None:
222222
security: A sequence of dicts that will be added to the schema of all route handlers in the application.
223223
See
224224
:data:`SecurityRequirement <.openapi.spec.SecurityRequirement>` for details.
225-
signature_namespace: A mapping of names to types for use in forward reference resolution during signature modeling.
226-
signature_types: A sequence of types for use in forward reference resolution during signature modeling.
225+
signature_namespace: A mapping of names to types for use in forward reference resolution during signature modelling.
226+
signature_types: A sequence of types for use in forward reference resolution during signature modelling.
227227
These types will be added to the signature namespace using their ``__name__`` attribute.
228228
state: An optional :class:`State <.datastructures.State>` for application state.
229229
static_files_config: A sequence of :class:`StaticFilesConfig <.static_files.StaticFilesConfig>`
@@ -483,8 +483,8 @@ async def test_my_handler() -> None:
483483
security: A sequence of dicts that will be added to the schema of all route handlers in the application.
484484
See
485485
:data:`SecurityRequirement <.openapi.spec.SecurityRequirement>` for details.
486-
signature_namespace: A mapping of names to types for use in forward reference resolution during signature modeling.
487-
signature_types: A sequence of types for use in forward reference resolution during signature modeling.
486+
signature_namespace: A mapping of names to types for use in forward reference resolution during signature modelling.
487+
signature_types: A sequence of types for use in forward reference resolution during signature modelling.
488488
These types will be added to the signature namespace using their ``__name__`` attribute.
489489
state: An optional :class:`State <.datastructures.State>` for application state.
490490
static_files_config: A sequence of :class:`StaticFilesConfig <.static_files.StaticFilesConfig>`

0 commit comments

Comments
 (0)