From 6a41e6002a60b06aed4e91f6685452be9a138ec9 Mon Sep 17 00:00:00 2001
From: Willem Lambooy <willem.lambooy@gmail.com>
Date: Wed, 24 May 2023 09:42:00 +0200
Subject: [PATCH] :memo: Split coordinate enumeration documentation into offset
 and cubic vs. SiQAD

---
 include/fiction/layouts/coordinates.hpp | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)

diff --git a/include/fiction/layouts/coordinates.hpp b/include/fiction/layouts/coordinates.hpp
index fb3760cf3..533563a0b 100644
--- a/include/fiction/layouts/coordinates.hpp
+++ b/include/fiction/layouts/coordinates.hpp
@@ -741,7 +741,8 @@ class coord_iterator
     /**
      * Standard constructor. Initializes the iterator with a starting position and the boundary within to enumerate.
      *
-     * With `dimension = (1, 2, 1)` and `start = (0, 0, 0)`, the following order would be enumerated:
+     * With `dimension = (1, 2, 1)` and `start = (0, 0, 0)`, the following order would be enumerated for offset or cubic
+     * coordinates:
      *
      * - (0, 0, 0)
      * - (1, 0, 0)
@@ -756,6 +757,21 @@ class coord_iterator
      * - (0, 2, 1)
      * - (1, 2, 1)
      *
+     * For SiQAD coordinates with the same parameters, we have the following order of enumeration:
+     *
+     * - (0, 0, 0)
+     * - (1, 0, 0)
+     * - (0, 0, 1)
+     * - (1, 0, 1)
+     * - (0, 1, 0)
+     * - (1, 2, 0)
+     * - (0, 1, 1)
+     * - (1, 1, 1)
+     * - (1, 1, 0)
+     * - (0, 2, 0)
+     * - (0, 2, 1)
+     * - (1, 2, 1)
+     *
      * coord_iterator is compatible with the STL forward_iterator category.
      *
      * @param dimension Boundary within to enumerate. Iteration wraps at its limits.