(Explicitly) document members of box_flags_enum

inducer · Dec 27, 2022 · 1423c46 · 1423c46
1 parent 972dcc0
commit 1423c46
Showing 1 changed file with 13 additions and 3 deletions.
diff --git a/boxtree/tree.py b/boxtree/tree.py
@@ -23,8 +23,6 @@
 .. currentmodule:: boxtree
 
 .. autoclass:: box_flags_enum
-    :members:
-    :undoc-members:
 
 .. autoclass:: TreeOfBoxes
 
@@ -98,7 +96,19 @@
 # {{{ box flags
 
 class box_flags_enum(Enum):  # noqa
-    """Constants for box flags bit field."""
+    """Constants for box flags bit field.
+
+    .. rubric:: Flags for particle-based trees
+
+    .. attribute:: dtype
+
+    .. attribute:: HAS_OWN_SOURCES
+    .. attribute:: HAS_OWN_TARGETS
+    .. attribute:: HAS_OWN_SRCNTGTS
+    .. attribute:: HAS_CHILD_SOURCES
+    .. attribute:: HAS_CHILD_TARGETS
+    .. attribute:: HAS_CHILD_PARTICLES
+    """
 
     c_name = "box_flags_t"
     dtype = np.dtype(np.uint8)