# Improve documentation for ArrayList, ArrayListUnmanaged, etc\. \(\#7624\) · gitcafe/zig

[View on GitCafe](https://git.cafe/gitcafe/zig/commit/db1e97d4b19d8399252e0fbc85fc3563b005a892)

Repository: [gitcafe/zig](https://git.cafe/gitcafe/zig)

Visibility: public

Requested revision: db1e97d4b19d8399252e0fbc85fc3563b005a892

Requested commit: db1e97d4b19d8399252e0fbc85fc3563b005a892

Commit: db1e97d4b19d8399252e0fbc85fc3563b005a892

Tree: 065247f953f6ea6f8926bc555d63d9472967cb4a

Author: Cameron Conn

Committer: GitHub

## Message

```
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
```

## Parents

- [1856dfea6b797d852b496c2111dbb326dbe2957e](https://git.cafe/gitcafe/zig/commit/1856dfea6b797d852b496c2111dbb326dbe2957e?format=markdown)

[Source at this commit](https://git.cafe/gitcafe/zig/tree/db1e97d4b19d8399252e0fbc85fc3563b005a892?format=markdown)