Skip to content

Commit 81321a0

Browse files
committed
Improve docstring of WriteOnceReadMany
1 parent d6f5cc1 commit 81321a0

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

src/write_once_read_many.jl

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
11
"""
2-
WriteOnceReadMany()
2+
WriteOnceReadMany{V}(container::V)
33
4-
Used for storing units, values, symbolic-units.
4+
A wrapper type for container that only defines methods
5+
for appending to and reading to, but not modifying the container.
6+
7+
This is so that we can safely define a `@register_unit` interface
8+
without needing to worry about the user overwriting previously
9+
defined units and voiding the indexing of symbolic dimensions.
510
"""
611
struct WriteOnceReadMany{V}
712
_raw_data::V

0 commit comments

Comments
 (0)