Skip to content

Commit b589fa1

Browse files
Add: Further Reading sections linking to CPython Internals
See zpoint.github.io/CPython-Internals.
1 parent e7134ca commit b589fa1

File tree

15 files changed

+70
-2
lines changed

15 files changed

+70
-2
lines changed

README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,9 +95,7 @@ uv lock --upgrade # Update dependencies
9595
│ ├── implementations/ # CPython, PyPy, Jython, IronPython
9696
│ └── versions/ # Python version guides (3.9–3.14)
9797
├── data/ # JSON data files
98-
│ └── documentation_audit.json
9998
├── scripts/ # Utility scripts
100-
│ └── audit_documentation.py
10199
├── tests/ # Test files
102100
├── .github/workflows/ # GitHub Actions CI/CD
103101
│ └── deploy.yml

docs/builtins/bytearray_func.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -366,3 +366,8 @@ ba[0] = 72 # O(1) - OK
366366
- **Python 2.x**: bytearray() available
367367
- **Python 3.x**: Same behavior
368368
- **All versions**: Mutable, unhashable
369+
370+
## Further Reading
371+
372+
- [CPython Internals: bytearray](https://zpoint.github.io/CPython-Internals/BasicObject/bytearray/bytearray.html) -
373+
Deep dive into CPython's bytearray implementation

docs/builtins/bytes.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -216,3 +216,8 @@ parts = data.split(b" ")
216216
- **[Strings](str.md)** - Unicode text
217217
- **[Lists](list.md)** - Mutable sequences
218218
- **Memoryview** - Zero-copy buffer interface
219+
220+
## Further Reading
221+
222+
- [CPython Internals: bytes](https://zpoint.github.io/CPython-Internals/BasicObject/bytes/bytes.html) -
223+
Deep dive into CPython's bytes implementation

docs/builtins/complex_func.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -397,3 +397,8 @@ c = complex.from_number(3.14) # (3.14+0j)
397397
- **Python 2.x**: Complex numbers available
398398
- **Python 3.x**: Same behavior, integrated well
399399
- **All versions**: 64-bit floating-point components
400+
401+
## Further Reading
402+
403+
- [CPython Internals: complex](https://zpoint.github.io/CPython-Internals/BasicObject/complex/complex.html) -
404+
Deep dive into CPython's complex implementation

docs/builtins/dict.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,3 +117,8 @@ d = {
117117
- **[Defaultdict](../stdlib/collections.md#defaultdict)** - Auto-default values
118118
- **[OrderedDict](../stdlib/collections.md#ordereddict)** - Explicit ordering (pre-3.6)
119119
- **[ChainMap](../stdlib/collections.md#chainmap)** - Multiple dict views
120+
121+
## Further Reading
122+
123+
- [CPython Internals: dict](https://zpoint.github.io/CPython-Internals/BasicObject/dict/dict.html) -
124+
Deep dive into CPython's dict implementation

docs/builtins/float.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -225,3 +225,8 @@ for i in range(1000000):
225225
- Comparing floats with `==` directly
226226
- Assuming decimal representation is exact
227227
- Using floats for financial calculations (use `Decimal`)
228+
229+
## Further Reading
230+
231+
- [CPython Internals: float](https://zpoint.github.io/CPython-Internals/BasicObject/float/float.html) -
232+
Deep dive into CPython's float implementation

docs/builtins/int.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,3 +195,8 @@ Similar performance characteristics with JIT compilation helping with:
195195
- **[Bool](bool.md)** - Boolean (subclass of int)
196196
- **Complex** - Complex numbers
197197
- **[Decimal](../stdlib/decimal.md)** - Arbitrary precision decimal
198+
199+
## Further Reading
200+
201+
- [CPython Internals: int](https://zpoint.github.io/CPython-Internals/BasicObject/long/long.html) -
202+
Deep dive into CPython's int implementation

docs/builtins/list.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,3 +97,8 @@ Similar, but may have different resize factors based on Java arrays.
9797
- **[Deque](../stdlib/collections.md#deque)** - O(1) append and prepend
9898
- **[Array](../stdlib/array.md)** - More memory efficient for large numeric lists
9999
- **[Tuple](tuple.md)** - Immutable alternative
100+
101+
## Further Reading
102+
103+
- [CPython Internals: list](https://zpoint.github.io/CPython-Internals/BasicObject/list/list.html) -
104+
Deep dive into CPython's list implementation

docs/builtins/set.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,3 +140,8 @@ filtered = [x for x in large_list if x not in exclusions_set]
140140
- **[Frozenset](index.md)** - Immutable set
141141
- **[Dict](dict.md)** - Mutable mapping
142142
- **[Deque](../stdlib/collections.md#deque)** - Ordered collection
143+
144+
## Further Reading
145+
146+
- [CPython Internals: set](https://zpoint.github.io/CPython-Internals/BasicObject/set/set.html) -
147+
Deep dive into CPython's set implementation

docs/builtins/str.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -208,3 +208,8 @@ if pattern.match(s): # Reuse compiled pattern
208208
- **[Bytes](bytes_func.md)** - Immutable byte sequence
209209
- **[Bytearray](bytearray_func.md)** - Mutable byte sequence
210210
- **[Regex (re)](../stdlib/re.md)** - Pattern matching
211+
212+
## Further Reading
213+
214+
- [CPython Internals: str](https://zpoint.github.io/CPython-Internals/BasicObject/str/str.html) -
215+
Deep dive into CPython's str implementation

0 commit comments

Comments
 (0)