Merge pull request #1794 from IntelPython/document-usm-ndarray-flags-obj

Documentation: Add doc page for `dpctl.tensor._flags.Flags` class

Author: ndgrigorian

docs/doc_sources/api_reference/dpctl/flags.rst

@@ -0,0 +1,22 @@
+.. _Flags_class:
+
+``Flags`` class
+===================
+
+.. autoclass:: dpctl.tensor._flags.Flags
+    :members:
+
+    Note that dictionary-like access to some members is permitted:
+
+        "C", "C_CONTIGUOUS":
+            Equivalent to ``c_contiguous``
+        "F", "F_CONTIGUOUS":
+            Equivalent to ``f_contiguous``
+        "W", "WRITABLE":
+            Equivalent to ``writable``
+        "FC":
+            Equivalent to ``fc``
+        "FNC":
+            Equivalent to ``fnc``
+        "FORC", "CONTIGUOUS":
+            Equivalent to ``forc`` and ``contiguous``

docs/doc_sources/api_reference/dpctl/tensor.usm_ndarray.rst

@@ -23,3 +23,8 @@ Implementation of :py:class:`usm_ndarray` conforms to
 .. _dpctl_tensor_usm_ndarray_to_device_example:
 
 .. include:: examples/usm_ndarray.rst
+
+.. toctree::
+    :hidden:
+
+    flags

dpctl/tensor/_flags.pyx

@@ -34,8 +34,9 @@ cdef cpp_bool _check_bit(int flag, int mask):
 
 cdef class Flags:
     """
-    Helper class to represent memory layout flags of
-    :class:`dpctl.tensor.usm_ndarray`.
+    Helper class to query the flags of a :class:`dpctl.tensor.usm_ndarray`
+    instance, which describe how the instance interfaces with its underlying
+    memory.
     """
     cdef int flags_
     cdef usm_ndarray arr_

dpctl/tensor/_usmarray.pyx

@@ -681,7 +681,7 @@ cdef class usm_ndarray:
     @property
     def flags(self):
         """
-        Returns :class:`dpctl.tensor._flags` object.
+        Returns :class:`dpctl.tensor._flags.Flags` object.
         """
         return _flags.Flags(self, self.flags_)