diff options
| author | Cameron Conn <camconn@users.noreply.github.com> | 2021-01-02 18:06:51 -0600 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-01-02 19:06:51 -0500 |
| commit | db1e97d4b19d8399252e0fbc85fc3563b005a892 (patch) | |
| tree | 065247f953f6ea6f8926bc555d63d9472967cb4a /lib/std/io/fixed_buffer_stream.zig | |
| parent | 1856dfea6b797d852b496c2111dbb326dbe2957e (diff) | |
| download | zig-db1e97d4b19d8399252e0fbc85fc3563b005a892.tar.gz zig-db1e97d4b19d8399252e0fbc85fc3563b005a892.zip | |
Improve documentation for ArrayList, ArrayListUnmanaged, etc. (#7624)
* Improve ArrayList & co documentation
- Added doc comments about the validity of references to elements in
an ArrayList and how they may become invalid after resizing operations.
- This should help users avoid footguns in future.
* Improve ArrayListUnmanaged & co's documentation
- Port improved documentation from ArrayList and ArrayList aligned to
their unmanaged counterparts.
- Made documentation for ArrayListUnmanaged & co more inclusive and
up-to-date.
- Made documentation more consistent with `ArrayList`.
* Corrections on ArrayList documentation.
- Remove incorrect/unpreferred wording on ArrayList vs
ArrayListUnmanaged.
- Fix notes about the alignment of ArrayListAligned
- Be more verbose with warnings on when pointers are invalidated.
- Copy+paste a few warnings
* add warning to replaceRange
* revert changes to append documentation
Diffstat (limited to 'lib/std/io/fixed_buffer_stream.zig')
0 files changed, 0 insertions, 0 deletions
