docs: added warning and updated docs

xgi-org · Jun 5, 2023 · 5e2b6f6 · 5e2b6f6
1 parent 62b38b5
commit 5e2b6f6
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 3 deletions.
diff --git a/xgi/classes/dihypergraph.py b/xgi/classes/dihypergraph.py
@@ -1,6 +1,8 @@
 """Base class for directed hypergraphs.
 
-**This is currently an experimental feature.**
+.. warning::
+    This is currently an experimental feature.
+
 """
 from collections.abc import Hashable, Iterable
 from copy import copy, deepcopy
@@ -17,6 +19,9 @@
 class DiHypergraph:
     r"""A dihypergraph is a collection of directed interactions of arbitrary size.
 
+    .. warning::
+        This is currently an experimental feature.
+
     More formally, a directed hypergraph (dihypergraph) is a pair :math:`(V, E)`,
     where :math:`V` is a set of elements called *nodes* or *vertices*,
     and :math:`E` is the set of directed hyperedges.

diff --git a/xgi/classes/direportviews.py b/xgi/classes/direportviews.py
@@ -1,3 +1,11 @@
+"""View classes for dihypergraphs.
+
+A View class allows for inspection and querying of an underlying object but does not
+allow modification.  This module provides View classes for nodes and edges of a dihypergraph.
+Views are automatically updaed when the dihypergraph changes.
+
+"""
+
 from collections.abc import Mapping, Set
 
 from ..exception import IDNotFound, XGIError
@@ -373,6 +381,9 @@ def _from_iterable(self, it):
 class DiNodeView(DiIDView):
     """An DiIDView that keeps track of node ids.
 
+    .. warning::
+        This is currently an experimental feature.
+
     Parameters
     ----------
     hypergraph : DiHypergraph
@@ -468,6 +479,9 @@ def memberships(self, n=None):
 class DiEdgeView(DiIDView):
     """An DiIDView that keeps track of edge ids.
 
+    .. warning::
+        This is currently an experimental feature.
+
     Parameters
     ----------
     hypergraph : DiHypergraph

diff --git a/xgi/classes/reportviews.py b/xgi/classes/reportviews.py
@@ -1,8 +1,8 @@
 """View classes for hypergraphs.
 
 A View class allows for inspection and querying of an underlying object but does not
-allow modification.  This module provides View classes for nodes, edges, degree, and
-edge size of a hypergraph.  Views are automatically updaed when the hypergraph changes.
+allow modification.  This module provides View classes for nodes and edges of a hypergraph.
+Views are automatically updaed when the hypergraph changes.
 
 """