Skip to content

Commit

Permalink
Improve documentation for ArrayList, ArrayListUnmanaged, etc. (ziglan…
Browse files Browse the repository at this point in the history
…g#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
  • Loading branch information
camconn authored Jan 3, 2021
1 parent 1856dfe commit db1e97d
Showing 1 changed file with 100 additions and 42 deletions.
Loading

0 comments on commit db1e97d

Please sign in to comment.