From fce73aa42e6cdf2f2a43df68b8448bcad48532b9 Mon Sep 17 00:00:00 2001 From: "Nevin \":-)\" Liber" Date: Wed, 29 Jan 2025 10:18:13 -0600 Subject: [PATCH] Added documentation that this is intended to replace std::array --- docs/source/API/core/stl-compat/Array.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/source/API/core/stl-compat/Array.rst b/docs/source/API/core/stl-compat/Array.rst index f8921ef73..114a10078 100644 --- a/docs/source/API/core/stl-compat/Array.rst +++ b/docs/source/API/core/stl-compat/Array.rst @@ -17,6 +17,7 @@ Description ``Array`` is a contiguous aggregate owning container storing a fixed size sequence of objects (models holding exactly N elements). +* This is intended as a replacement for ``std::array``. * This container is an owning container (the data is embeddded in the container itself). * This container is an aggregate type with the same semantics as a struct holding a C-style array ``T[N]`` as its only non-static data member when ``N > 0``; otherwise, it is an empty container. * Unlike a C-style array, it doesn't decay to ``T*`` automatically.