Skip to content

Commit 07a8fa9

Browse files
committed
Improved docs
Signed-off-by: Andrea Zoppi <[email protected]>
1 parent ad3af59 commit 07a8fa9

28 files changed

+1110
-879
lines changed

CHANGELOG.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11
Changelog
22
=========
33

4+
0.1.0 (2024-02-22)
5+
------------------
6+
7+
* Improved documentation.
8+
* Version number deserved something more stable.
9+
10+
411
0.0.8 (2024-01-21)
512
------------------
613

docs/_autosummary/bytesparse.base.HUMAN_ASCII.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
bytesparse.base.HUMAN\_ASCII
2-
============================
1+
HUMAN\_ASCII
2+
============
33

44
.. currentmodule:: bytesparse.base
55

Lines changed: 80 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -1,83 +1,84 @@
1-
bytesparse.base.ImmutableMemory
2-
===============================
1+
ImmutableMemory
2+
===============
33

44
.. currentmodule:: bytesparse.base
55

66
.. autoclass:: ImmutableMemory
7-
:members:
8-
:inherited-members:
9-
:private-members:
10-
:special-members:
11-
12-
13-
14-
.. rubric:: Methods
15-
16-
.. autosummary::
17-
:nosignatures:
18-
19-
~ImmutableMemory.__init__
20-
~ImmutableMemory.block_span
21-
~ImmutableMemory.blocks
22-
~ImmutableMemory.bound
23-
~ImmutableMemory.chop
24-
~ImmutableMemory.collapse_blocks
25-
~ImmutableMemory.content_blocks
26-
~ImmutableMemory.content_items
27-
~ImmutableMemory.content_keys
28-
~ImmutableMemory.content_values
29-
~ImmutableMemory.copy
30-
~ImmutableMemory.count
31-
~ImmutableMemory.equal_span
32-
~ImmutableMemory.extract
33-
~ImmutableMemory.find
34-
~ImmutableMemory.from_blocks
35-
~ImmutableMemory.from_bytes
36-
~ImmutableMemory.from_items
37-
~ImmutableMemory.from_memory
38-
~ImmutableMemory.from_values
39-
~ImmutableMemory.fromhex
40-
~ImmutableMemory.gaps
41-
~ImmutableMemory.get
42-
~ImmutableMemory.hex
43-
~ImmutableMemory.hexdump
44-
~ImmutableMemory.index
45-
~ImmutableMemory.intervals
46-
~ImmutableMemory.items
47-
~ImmutableMemory.keys
48-
~ImmutableMemory.peek
49-
~ImmutableMemory.read
50-
~ImmutableMemory.readinto
51-
~ImmutableMemory.rfind
52-
~ImmutableMemory.rindex
53-
~ImmutableMemory.rvalues
54-
~ImmutableMemory.to_blocks
55-
~ImmutableMemory.to_bytes
56-
~ImmutableMemory.validate
57-
~ImmutableMemory.values
58-
~ImmutableMemory.view
59-
60-
61-
62-
63-
64-
.. rubric:: Attributes
65-
66-
.. autosummary::
67-
68-
~ImmutableMemory.bound_endex
69-
~ImmutableMemory.bound_span
70-
~ImmutableMemory.bound_start
71-
~ImmutableMemory.content_endex
72-
~ImmutableMemory.content_endin
73-
~ImmutableMemory.content_parts
74-
~ImmutableMemory.content_size
75-
~ImmutableMemory.content_span
76-
~ImmutableMemory.content_start
77-
~ImmutableMemory.contiguous
78-
~ImmutableMemory.endex
79-
~ImmutableMemory.endin
80-
~ImmutableMemory.span
81-
~ImmutableMemory.start
82-
83-
7+
:members:
8+
:inherited-members:
9+
:private-members:
10+
:special-members:
11+
12+
13+
14+
15+
.. rubric:: Attributes
16+
17+
.. autosummary::
18+
19+
~ImmutableMemory.bound_endex
20+
~ImmutableMemory.bound_span
21+
~ImmutableMemory.bound_start
22+
~ImmutableMemory.content_endex
23+
~ImmutableMemory.content_endin
24+
~ImmutableMemory.content_parts
25+
~ImmutableMemory.content_size
26+
~ImmutableMemory.content_span
27+
~ImmutableMemory.content_start
28+
~ImmutableMemory.contiguous
29+
~ImmutableMemory.endex
30+
~ImmutableMemory.endin
31+
~ImmutableMemory.span
32+
~ImmutableMemory.start
33+
34+
35+
36+
37+
38+
39+
.. rubric:: Methods
40+
41+
.. autosummary::
42+
:nosignatures:
43+
44+
~ImmutableMemory.__init__
45+
~ImmutableMemory.block_span
46+
~ImmutableMemory.blocks
47+
~ImmutableMemory.bound
48+
~ImmutableMemory.chop
49+
~ImmutableMemory.collapse_blocks
50+
~ImmutableMemory.content_blocks
51+
~ImmutableMemory.content_items
52+
~ImmutableMemory.content_keys
53+
~ImmutableMemory.content_values
54+
~ImmutableMemory.copy
55+
~ImmutableMemory.count
56+
~ImmutableMemory.equal_span
57+
~ImmutableMemory.extract
58+
~ImmutableMemory.find
59+
~ImmutableMemory.from_blocks
60+
~ImmutableMemory.from_bytes
61+
~ImmutableMemory.from_items
62+
~ImmutableMemory.from_memory
63+
~ImmutableMemory.from_values
64+
~ImmutableMemory.fromhex
65+
~ImmutableMemory.gaps
66+
~ImmutableMemory.get
67+
~ImmutableMemory.hex
68+
~ImmutableMemory.hexdump
69+
~ImmutableMemory.index
70+
~ImmutableMemory.intervals
71+
~ImmutableMemory.items
72+
~ImmutableMemory.keys
73+
~ImmutableMemory.peek
74+
~ImmutableMemory.read
75+
~ImmutableMemory.readinto
76+
~ImmutableMemory.rfind
77+
~ImmutableMemory.rindex
78+
~ImmutableMemory.rvalues
79+
~ImmutableMemory.to_blocks
80+
~ImmutableMemory.to_bytes
81+
~ImmutableMemory.validate
82+
~ImmutableMemory.values
83+
~ImmutableMemory.view
84+

0 commit comments

Comments
 (0)