Skip to content

Commit ffb3d54

Browse files
committed
docs: add more details
1 parent 5604952 commit ffb3d54

2 files changed

Lines changed: 4 additions & 4 deletions

File tree

bench/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Performance Benchmarks
22

3-
This directory contains reproducible performance benchmarks for `typeid-python`.
3+
This `./bench` directory contains reproducible performance benchmarks for `typeid-python`.
44

55
The goal is to transparently demonstrate:
66
- the impact of the Rust base32 implementation,
@@ -51,7 +51,7 @@ We maintain multiple benchmark snapshots to show progress over time:
5151
| ID | Description |
5252
| -------- | -------------------------------------------------------------------- |
5353
| **0001** | Pure Python implementation (before Rust) |
54-
| **0004** | Rust base32 + `uuid-utils` + lazy UUID + single decode optimizations |
54+
| **0002** | Rust base32 + `uuid-utils` + lazy UUID + single decode optimizations |
5555

5656
Raw benchmark data:
5757

docs/quickstart.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,9 +118,9 @@ You can always extract the UUID:
118118
tid.uuid
119119
```
120120

121-
> [!NOTE]
121+
> **_NOTE:_**
122122
> The exact Python type returned by `tid.uuid` depends on the available backend.
123-
> For time-related information, prefer `typeid explain` or derived properties
123+
> For time-related information, prefer `typeid explain` or derived properties (`.creation_time` and `.timestamp_ms`)
124124
> over backend-specific UUID attributes.
125125
126126
And you can always reconstruct a TypeID from a UUID:

0 commit comments

Comments
 (0)