Skip to content

Commit

Permalink
docs: Fix a few typos
Browse files Browse the repository at this point in the history
There are small typos in:
- docs/extensions.rst
- docs/upgrade.rst
- tinydb/queries.py

Fixes:
- Should read `truncate` rather than `trunacte`.
- Should read `synchronous` rather than `syncronous`.
- Should read `function` rather than `fuction`.
- Should read `explicitly` rather than `explicitely`.
  • Loading branch information
timgates42 authored and msiemens committed Jul 23, 2022
1 parent fcb1a86 commit 6307a9f
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/extensions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Here are some extensions that might be useful to you:
| **Repo:** https://github.com/ASMfreaK/aiotinydb
| **Status:** *stable*
| **Description:** asyncio compatibility shim for TinyDB. Enables usage of
TinyDB in asyncio-aware contexts without slow syncronous
TinyDB in asyncio-aware contexts without slow synchronous
IO.

Expand Down
4 changes: 2 additions & 2 deletions docs/upgrade.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Version 4.0
- API changes:
- Replace ``TinyDB.purge_tables(...)`` with ``TinyDB.drop_tables(...)``
- Replace ``TinyDB.purge_table(...)`` with ``TinyDB.drop_table(...)``
- Replace ``Table.purge()`` with ``Table.trunacte()``
- Replace ``Table.purge()`` with ``Table.truncate()``
- Replace ``TinyDB(default_table='name')`` with ``TinyDB.default_table_name = 'name'``
- Replace ``TinyDB(table_class=Class)`` with ``TinyDB.table_class = Class``
- If you were using ``TinyDB.DEFAULT_TABLE``, ``TinyDB.DEFAULT_TABLE_KWARGS``,
Expand All @@ -35,7 +35,7 @@ Breaking API Changes
notation can be used: ``where('a.b.c')`` is now
``Query()['a.b.c']``.

- Checking for the existence of a key has to be done explicitely:
- Checking for the existence of a key has to be done explicitly:
``where('foo').exists()``.

- ``SmartCacheTable`` has been moved to `msiemens/tinydb-smartcache`_.
Expand Down
2 changes: 1 addition & 1 deletion tinydb/queries.py
Original file line number Diff line number Diff line change
Expand Up @@ -382,7 +382,7 @@ def test(self, func: Callable[[Mapping], bool], *args) -> QueryInstance:
.. warning::
The test fuction provided needs to be deterministic (returning the
The test function provided needs to be deterministic (returning the
same value when provided with the same arguments), otherwise this
may mess up the query cache that :class:`~tinydb.table.Table`
implements.
Expand Down

0 comments on commit 6307a9f

Please sign in to comment.