You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
Copy file name to clipboardExpand all lines: README.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ This is a **thread-safe** and **dependency-free** **in-memory** **LRU storage**
7
7
8
8
You can define:
9
9
10
-
-**limits** (`max-items` or `max-size-in-bytes`)
10
+
-**limits** (`max_items` or `size_limit_in_bytes`)
11
11
-**TTL expiration** (globally or per item)
12
12
13
13
to prevent the storage from growing too big.
@@ -60,7 +60,7 @@ cache.close()
60
60
61
61
### Low level API *(without serialization/deserialization)*
62
62
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.
Copy file name to clipboardExpand all lines: docs/tutorials/quickstart.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ The main use-case is to use it as a **cache** for your data. You store any kind
14
14
15
15
## Low level API *(without serialization/deserialization)*
16
16
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.
0 commit comments