Skip to content

Commit 0d66832

Browse files
Fix documentation linting issues and update markdownlint config
- Remove redundant 'interface' after 'API' in docs/adapters.md - Add periods to 'etc' abbreviations in docs/index.md - Remove redundant 'together' in docs/wrappers.md - Add MD024 siblings_only config to allow duplicate headings in sections - Update uv.lock with documentation dependencies Co-authored-by: William Easton <[email protected]>
1 parent 8b9eba3 commit 0d66832

File tree

5 files changed

+477
-22
lines changed

5 files changed

+477
-22
lines changed

.markdownlint.jsonc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,8 @@
55
"line_length": 80,
66
"code_blocks": false, // Don't restrict line length in code blocks
77
"tables": false // Don't restrict line length in tables
8+
},
9+
"MD024": {
10+
"siblings_only": true // Allow duplicate headings in different sections
811
}
912
}

docs/adapters.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ provide alternative APIs tailored for specific use cases.
1515

1616
**Adapters:**
1717

18-
- Provide a different API interface
18+
- Provide a different API
1919
- Cannot be used in place of a store
2020
- Add type safety and specialized behavior
2121
- Transform how you interact with the store
@@ -32,7 +32,7 @@ integrity.
3232
options:
3333
show_source: false
3434
members:
35-
- __init__
35+
- **init**
3636
- get
3737
- get_many
3838
- put
@@ -257,7 +257,7 @@ error instead of returning `None` when a key is not found.
257257
options:
258258
show_source: false
259259
members:
260-
- __init__
260+
- **init**
261261
- get
262262
- get_many
263263

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ type safety, and extensible wrappers.
99
py-key-value is a Python framework that offers:
1010

1111
- **Multiple backends**: DynamoDB, Elasticsearch, Memcached, MongoDB, Redis,
12-
RocksDB, Valkey, and In-memory, Disk, etc
12+
RocksDB, Valkey, and In-memory, Disk, etc.
1313
- **TTL support**: Automatic expiration handling across all store types
1414
- **Type-safe**: Full type hints with Protocol-based interfaces
15-
- **Adapters**: Pydantic model support, raise-on-missing behavior, etc
15+
- **Adapters**: Pydantic model support, raise-on-missing behavior, etc.
1616
- **Wrappers**: Statistics tracking, encryption, compression, and more
1717
- **Collection-based**: Organize keys into logical collections/namespaces
1818
- **Pluggable architecture**: Easy to add custom store implementations

docs/wrappers.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ protocol, so they can be used anywhere a store can be used.
88

99
Wrappers follow the decorator pattern - they wrap around a key-value store and
1010
intercept operations to add additional behavior. Multiple wrappers can be
11-
stacked together to combine their effects.
11+
stacked to combine their effects.
1212

1313
### Wrapper Pattern Example
1414

@@ -43,7 +43,7 @@ compression.
4343
options:
4444
show_source: false
4545
members:
46-
- __init__
46+
- **init**
4747

4848
#### Use Cases
4949

@@ -88,7 +88,7 @@ encryption.
8888
options:
8989
show_source: false
9090
members:
91-
- __init__
91+
- **init**
9292

9393
#### Use Cases
9494

@@ -138,7 +138,7 @@ Provides failover to a secondary store if the primary store fails.
138138
options:
139139
show_source: false
140140
members:
141-
- __init__
141+
- **init**
142142

143143
#### Use Cases
144144

@@ -173,7 +173,7 @@ specified size.
173173
options:
174174
show_source: false
175175
members:
176-
- __init__
176+
- **init**
177177

178178
#### Use Cases
179179

@@ -210,7 +210,7 @@ Logs all key-value operations for debugging and auditing.
210210
options:
211211
show_source: false
212212
members:
213-
- __init__
213+
- **init**
214214

215215
#### Use Cases
216216

@@ -247,7 +247,7 @@ Provides read-through caching with a fast local cache and a slower remote store.
247247
options:
248248
show_source: false
249249
members:
250-
- __init__
250+
- **init**
251251

252252
#### Use Cases
253253

@@ -284,7 +284,7 @@ Adds a prefix to all collection names.
284284
options:
285285
show_source: false
286286
members:
287-
- __init__
287+
- **init**
288288

289289
#### Use Cases
290290

@@ -321,7 +321,7 @@ Adds a prefix to all keys.
321321
options:
322322
show_source: false
323323
members:
324-
- __init__
324+
- **init**
325325

326326
#### Use Cases
327327

@@ -358,7 +358,7 @@ Prevents all write operations, making the store read-only.
358358
options:
359359
show_source: false
360360
members:
361-
- __init__
361+
- **init**
362362

363363
#### Use Cases
364364

@@ -390,7 +390,7 @@ Automatically retries failed operations with exponential backoff.
390390
options:
391391
show_source: false
392392
members:
393-
- __init__
393+
- **init**
394394

395395
#### Use Cases
396396

@@ -427,7 +427,7 @@ parameter.
427427
options:
428428
show_source: false
429429
members:
430-
- __init__
430+
- **init**
431431

432432
#### Use Cases
433433

@@ -461,7 +461,7 @@ bounds.
461461
options:
462462
show_source: false
463463
members:
464-
- __init__
464+
- **init**
465465

466466
#### Use Cases
467467

@@ -499,7 +499,7 @@ Tracks operation statistics including counts, hits, and misses.
499499
options:
500500
show_source: false
501501
members:
502-
- __init__
502+
- **init**
503503
- get_statistics
504504
- reset_statistics
505505

@@ -546,7 +546,7 @@ exceed the specified timeout.
546546
options:
547547
show_source: false
548548
members:
549-
- __init__
549+
- **init**
550550

551551
#### Use Cases
552552

0 commit comments

Comments
 (0)