Skip to content

Commit f5c7cde

Browse files
kianmengsteve-chavez
authored andcommitted
docs: fix typos
Found via `codespell -S test -L notin,nam,plantext,cryto,corelation,inout,ot`
1 parent 0018c38 commit f5c7cde

20 files changed

Lines changed: 28 additions & 28 deletions

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -610,7 +610,7 @@ All notable changes to this project will be documented in this file. From versio
610610
### Added
611611

612612
- #1933, #2109, Add a minimal health check endpoint - @steve-chavez
613-
+ For enabling this, the `admin-server-port` config must be set explictly
613+
+ For enabling this, the `admin-server-port` config must be set explicitly
614614
+ A `<host>:<admin_server_port>/live` endpoint is available for checking if postgrest is running on its port/socket. 200 OK = alive, 503 = dead.
615615
+ A `<host>:<admin_server_port>/ready` endpoint is available for checking a correct internal state(the database connection plus the schema cache). 200 OK = ready, 503 = not ready.
616616
- #1988, Add the current user to the request log on stdout - @DavidLindbom, @wolfgangwalther
@@ -1093,7 +1093,7 @@ All notable changes to this project will be documented in this file. From versio
10931093
- Customize content negotiation per route - @begriffs
10941094
- Allow using nulls order without explicit order direction - @steve-chavez
10951095
- Fatal error on postgres unsupported version, format supported version in error message - @steve-chavez
1096-
- Prevent database memory cosumption by prepared statements caches - @ruslantalpa
1096+
- Prevent database memory consumption by prepared statements caches - @ruslantalpa
10971097
- Use specific columns in the RETURNING section - @ruslantalpa
10981098
- Fix columns alias for RETURNING - @steve-chavez
10991099

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@
4848
# The master toctree document.
4949
master_doc = "index"
5050

51-
# This is overriden by readthedocs with the version tag anyway
51+
# This is overridden by readthedocs with the version tag anyway
5252
version = "devel"
5353
# To avoid repetition in <title> we set this to an empty string.
5454
release = ""

docs/ecosystem.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Community Tutorials
66
* `Building a Contacts List with PostgREST and Vue.js <https://www.youtube.com/watch?v=iHtsALtD5-U>`_ -
77
In this video series, DigitalOcean shows how to build and deploy an Nginx + PostgREST(using a managed PostgreSQL database) + Vue.js webapp in an Ubuntu server droplet.
88

9-
* `PostgREST + Auth0: Create REST API in mintutes, and add social login using Auth0 <https://samkhawase.com/blog/postgrest/>`_ - A step-by-step tutorial to show how to dockerize and integrate Auth0 to PostgREST service.
9+
* `PostgREST + Auth0: Create REST API in minutes, and add social login using Auth0 <https://samkhawase.com/blog/postgrest/>`_ - A step-by-step tutorial to show how to dockerize and integrate Auth0 to PostgREST service.
1010

1111
* `"CodeLess" backend using postgres, postgrest and oauth2 authentication with keycloak <https://www.mathieupassenaud.fr/codeless_backend/>`_ -
1212
A step-by-step tutorial for using PostgREST with KeyCloak(hosted on a managed service).

docs/explanations/db_authz.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ Another option is to define the function with the :code:`SECURITY DEFINER` optio
163163

164164
.. code-block:: postgres
165165
166-
-- login as a user wich has privileges on the private schemas
166+
-- login as a user which has privileges on the private schemas
167167
168168
-- create a sample function
169169
create or replace function login(email text, pass text, out token text) as $$

docs/references/api/media_type_handlers.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Using these domains, :ref:`functions <functions>` can become handlers and `user-
1515

1616
.. important::
1717

18-
- PostgREST vendor media types (``application/vnd.pgrst.plan``, ``application/vnd.pgrst.object`` and ``application/vnd.pgrst.array``) cannot be overriden.
18+
- PostgREST vendor media types (``application/vnd.pgrst.plan``, ``application/vnd.pgrst.object`` and ``application/vnd.pgrst.array``) cannot be overridden.
1919
- Long media types like ``application/vnd.openxmlformats-officedocument.wordprocessingml.document`` cannot be expressed as domains since they surpass `PostgreSQL identifier length <https://www.postgresql.org/docs/current/limits.html#LIMITS-TABLE>`_.
2020
For these you can use the :ref:`any_handler`.
2121

docs/references/api/resource_embedding.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1244,7 +1244,7 @@ You can order the correlated arrays explicitly. For example, to order by the fil
12441244
12451245
.. warning::
12461246
1247-
Aliasing spreaded columns is recommended since JSON allows duplicate keys. Example:
1247+
Aliasing spread columns is recommended since JSON allows duplicate keys. Example:
12481248
12491249
.. code-block:: bash
12501250

docs/references/api/tables_views.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -639,7 +639,7 @@ However, it can work with surrogate primary keys (e.g. ``id serial primary key``
639639
640640
.. code-block:: bash
641641
642-
curl "http://localhost:3000/employees?colums=id,name,salary" \
642+
curl "http://localhost:3000/employees?columns=id,name,salary" \
643643
-X POST -H "Content-Type: application/json" \
644644
-H "Prefer: resolution=merge-duplicates, missing=default" \
645645
-d @- << EOF

docs/references/auth.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ It's recommended to leave the JWT cache enabled as our load tests indicate ~20%
217217

218218
- If the ``jwt-secret`` is changed and the config is reloaded, the JWT cache will reset.
219219
- JWTs that pass :ref:`jwt_signature` are cached, regardless if they pass :ref:`jwt_claims_validation`. We do this to ensure responses stays fast under common failure cases (such as expired JWTs).
220-
- You can use the :ref:`server-timing_header` to see the peformance benefit of JWT caching.
220+
- You can use the :ref:`server-timing_header` to see the performance benefit of JWT caching.
221221

222222
.. _jwt_role_extract:
223223

docs/references/configuration.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -264,7 +264,7 @@ db-channel-enabled
264264

265265
When this is set to :code:`true`, the notification channel specified in :ref:`db-channel` is enabled.
266266

267-
You should set this to ``false`` when using PostgresSQL behind an external connection pooler such as PgBouncer working in transaction pooling mode. See :ref:`this section <external_connection_poolers>` for more information.
267+
You should set this to ``false`` when using PostgreSQL behind an external connection pooler such as PgBouncer working in transaction pooling mode. See :ref:`this section <external_connection_poolers>` for more information.
268268

269269
.. _db-config:
270270

@@ -479,7 +479,7 @@ db-prepared-statements
479479

480480
When disabled, the generated queries will be parameterized (invulnerable to SQL injection) but they will not be prepared (cached in the database session). Not using prepared statements will noticeably decrease performance, so it's recommended to always have this setting enabled.
481481

482-
You should only set this to ``false`` when using PostgresSQL behind an external connection pooler such as PgBouncer working in transaction pooling mode. See :ref:`this section <external_connection_poolers>` for more information.
482+
You should only set this to ``false`` when using PostgreSQL behind an external connection pooler such as PgBouncer working in transaction pooling mode. See :ref:`this section <external_connection_poolers>` for more information.
483483

484484
.. _db-root-spec:
485485

docs/references/transactions.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ Notice that the ``response.headers`` should be set to an *array* of single-key o
221221

222222
.. note::
223223

224-
PostgREST provided headers such as ``Content-Type``, ``Location``, etc. can be overriden this way. Note that irrespective of overridden ``Content-Type`` response header, the content will still be converted to JSON, unless you use :ref:`custom_media`.
224+
PostgREST provided headers such as ``Content-Type``, ``Location``, etc. can be overridden this way. Note that irrespective of overridden ``Content-Type`` response header, the content will still be converted to JSON, unless you use :ref:`custom_media`.
225225

226226
.. _guc_resp_status:
227227

0 commit comments

Comments
 (0)