Repository navigation
Commit 005fdd1
committed
docs(codecs): fix stale storage-path and hash-algorithm docstrings
Three built-in codec class docstrings described pre-2.3.1 storage
layouts (and HashCodec claimed the wrong hash algorithm entirely):
- HashCodec: said 'SHA256'; actually MD5 + Base32
(hash_registry.py:65-67). Layout said
'_hash/{hash[:2]}/{hash[2:4]}/{hash}'; actually
'{hash_prefix}/{schema}/{hash}' with hash_prefix defaulting to
'_hash' and no [:2]/[:4] split anywhere in code.
- NpyCodec: layout said '{schema}/{table}/{pk}/{attribute}.npy';
actually '{schema_prefix}/{schema}/{table}/{pk}/{attribute}_{token}.npy'
after #1479 added the schema_prefix section and the random token
suffix (via storage.build_object_path).
- ObjectCodec: same drift as NpyCodec, as a directory rather than a
file.
All three docstrings had their 'Deletion:' line updated in v2.3.1
(dj.gc.collect() -> dj.gc.GarbageCollector) but the surrounding path
claims were left stale.
Docs-only.1 parent af76ab9 commit 005fdd1
3 files changed
Lines changed: 14 additions & 8 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | | - | |
| 2 | + | |
3 | 3 | | |
4 | 4 | | |
5 | 5 | | |
| |||
12 | 12 | | |
13 | 13 | | |
14 | 14 | | |
15 | | - | |
| 15 | + | |
16 | 16 | | |
17 | 17 | | |
18 | | - | |
19 | | - | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
20 | 22 | | |
21 | 23 | | |
22 | 24 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
226 | 226 | | |
227 | 227 | | |
228 | 228 | | |
229 | | - | |
| 229 | + | |
| 230 | + | |
| 231 | + | |
230 | 232 | | |
231 | 233 | | |
232 | 234 | | |
| |||
269 | 271 | | |
270 | 272 | | |
271 | 273 | | |
272 | | - | |
| 274 | + | |
273 | 275 | | |
274 | 276 | | |
275 | 277 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
15 | 15 | | |
16 | 16 | | |
17 | 17 | | |
18 | | - | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
19 | 21 | | |
20 | 22 | | |
21 | 23 | | |
| |||
51 | 53 | | |
52 | 54 | | |
53 | 55 | | |
54 | | - | |
| 56 | + | |
55 | 57 | | |
56 | 58 | | |
57 | 59 | | |
| |||
0 commit comments