Skip to content

Commit 8625c11

Browse files
committed
fixed documentation
1 parent d2d6d8e commit 8625c11

File tree

2 files changed

+7
-13
lines changed

2 files changed

+7
-13
lines changed

Makefile

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ doc-deploy: ## Run Deploy Documentation
3838
make clean
3939
mkdocs gh-deploy --force --ignore-version
4040

41+
doc-serve: ## Launch doc local server
42+
make mkdoc serve
4143

4244
pre-commit-lint: ## Runs Requires commands during pre-commit
4345
make clean

docs/caching.md

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Memcached runs as a daemon and is allotted a specified amount of RAM. All it doe
3131
After installing Memcached itself, you’ll need to install a Memcached binding.
3232
There are several Python Memcached bindings available;
3333

34-
Ellar supports are [pylibmc](https://pypi.org/project/pylibmc/), [pymemcache](https://pypi.org/project/pymemcache/) and [aiomcache](https://github.com/aio-libs/aiomcache)
34+
Ellar supports are [pylibmc](https://pypi.org/project/pylibmc/) and [pymemcache](https://pypi.org/project/pymemcache/)
3535

3636
For an example, lets assume you have a Memcached is running on localhost (127.0.0.1) port 11211, using the `pymemcache` or `pylibmc` binding:
3737

@@ -59,18 +59,6 @@ For an example, lets assume you have a Memcached is running on localhost (127.0.
5959
'default': PyLibMCCacheBackend(servers=['127.0.0.1:11211'])
6060
}
6161
```
62-
=== "aiomcache"
63-
```python
64-
# project_name/config.py
65-
66-
from ellar.core import ConfigDefaultTypesMixin
67-
from ellar.cache.backends.aio_cache import AioMemCacheBackend
68-
69-
class DevelopmentConfig(ConfigDefaultTypesMixin):
70-
CACHES = {
71-
'default': AioMemCacheBackend(host='127.0.0.1', port=11211)
72-
}
73-
```
7462
If Memcached is available through a local Unix socket file /tmp/memcached.sock using the `pymemcache` or `pylibmc` binding:
7563

7664

@@ -333,6 +321,10 @@ The CacheService class provides methods like:
333321
- **has_key_async**_**(key: str, version: str = None, backend: str = None)**_: asynchronous version of `has_key` action
334322
- **touch**_**(key: str, timeout: t.Union[float, int] = None, version: str = None, backend: str = None)**_: sets a new expiration for a key
335323
- **touch_async**_**(key: str, timeout: t.Union[float, int] = None, version: str = None, backend: str = None)**_: asynchronous version of `touch` action
324+
- **incr**_**(key: str, delta: int = 1, version: str = None, backend: str = None)**_: increments a value for a key by delta
325+
- **incr_async**_**(key: str, delta: int = 1, version: str = None, backend: str = None)**_: asynchronous version of `incr` action
326+
- **decr**_**(key: str, delta: int = 1, version: str = None, backend: str = None)**_: decrement a value for a key by delta
327+
- **decr_async**_**(key: str, delta: int = 1, version: str = None, backend: str = None)**_: asynchronous version of `decr` action
336328

337329
!!! note
338330
If `backend=None`, `default` backend configuration is used.

0 commit comments

Comments
 (0)