Skip to content

Commit 6db19b0

Browse files
authored
fix: use correct Python parameter names in documentation (#58)
* fix: use correct Python parameter names in documentation Replace hyphenated names (max-items, max-size-in-bytes) with the actual constructor parameter names (max_items, size_limit_in_bytes) in what_is_this.md and quickstart.md. Closes #51 Made-with: Cursor * chore: regenerate README.md from updated docs templates Made-with: Cursor
1 parent 6c452eb commit 6db19b0

3 files changed

Lines changed: 4 additions & 4 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This is a **thread-safe** and **dependency-free** **in-memory** **LRU storage**
77

88
You can define:
99

10-
- **limits** (`max-items` or `max-size-in-bytes`)
10+
- **limits** (`max_items` or `size_limit_in_bytes`)
1111
- **TTL expiration** (globally or per item)
1212

1313
to prevent the storage from growing too big.
@@ -60,7 +60,7 @@ cache.close()
6060

6161
### Low level API *(without serialization/deserialization)*
6262

63-
But you can use it at a lower level to store any kind of data type **without serialization**. In that case, you will lose the `max-size-in-bytes` feature but you still get the `max-items` feature.
63+
But you can use it at a lower level to store any kind of data type **without serialization**. In that case, you will lose the `size_limit_in_bytes` feature but you still get the `max_items` feature.
6464

6565
```python
6666
from atomic_lru import CACHE_MISS, Storage

docs/_includes/what_is_this.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This is a **thread-safe** and **dependency-free** **in-memory** **LRU storage**
44

55
You can define:
66

7-
- **limits** (`max-items` or `max-size-in-bytes`)
7+
- **limits** (`max_items` or `size_limit_in_bytes`)
88
- **TTL expiration** (globally or per item)
99

1010
to prevent the storage from growing too big.

docs/tutorials/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The main use-case is to use it as a **cache** for your data. You store any kind
1414

1515
## Low level API *(without serialization/deserialization)*
1616

17-
But you can use it at a lower level to store any kind of data type **without serialization**. In that case, you will lose the `max-size-in-bytes` feature but you still get the `max-items` feature.
17+
But you can use it at a lower level to store any kind of data type **without serialization**. In that case, you will lose the `size_limit_in_bytes` feature but you still get the `max_items` feature.
1818

1919
```python
2020
{% include 'tutorials/lowlevel.py' %}

0 commit comments

Comments
 (0)