updates

xgi-org · Sep 6, 2024 · c65911e · c65911e
1 parent e5eea3e
commit c65911e
Show file tree

Hide file tree

Showing 9 changed files with 29 additions and 50 deletions.
diff --git a/docs/source/api/recipes.rst b/docs/source/api/recipes.rst
diff --git a/docs/source/api/tutorials.rst b/docs/source/api/tutorials.rst
diff --git a/docs/source/api/tutorials/focus.rst b/docs/source/api/tutorials/focus.rst
@@ -16,5 +16,5 @@ Focus tutorials
 
 .. seealso:: 
 
-   This is now too easy and you want to dive deeper into some features of XGI?
+   Is this too easy and you want to dive deeper into some features of XGI?
    Go to the `In-depth Tutorials <in_depth.html>`_.
diff --git a/docs/source/api/tutorials/getting_started.rst b/docs/source/api/tutorials/getting_started.rst
@@ -1,5 +1,3 @@
-.. _xgi_in_x_minutes:
-
 ###############
 Getting started
 ###############

diff --git a/docs/source/api/tutorials/in_depth.rst b/docs/source/api/tutorials/in_depth.rst
@@ -1,7 +1,4 @@
-.. _indepth_tutorials:
-
-
-##################
+.##################
 In Depth tutorials
 ##################
 

diff --git a/docs/source/user_guides.rst b/docs/source/user_guides.rst
@@ -17,7 +17,7 @@ User Guides
 
     	+++
 
-        .. button-ref:: xgi_in_x_minutes
+        .. button-ref:: api/tutorials/getting_started
             :expand:
             :color: secondary
             :click-parent:
@@ -35,7 +35,7 @@ User Guides
 
     	+++
 
-        .. button-ref:: focus_tutorials
+        .. button-ref:: api/tutorials/focus
             :expand:
             :color: secondary
             :click-parent:
@@ -55,7 +55,7 @@ User Guides
     	To know everything there is to know about a specific feature of XGI 
     	+++
 
-        .. button-ref:: indepth_tutorials
+        .. button-ref:: api/tutorials/in_depth
             :expand:
             :color: secondary
             :click-parent:
@@ -72,7 +72,7 @@ User Guides
 
     	+++
 
-        .. button-ref:: recipes
+        .. button-ref:: api/recipes/recipes
             :expand:
             :color: secondary
             :click-parent:

diff --git a/xgi/convert/encapsulation_dag.py b/xgi/convert/encapsulation_dag.py
@@ -20,18 +20,19 @@ def to_encapsulation_dag(H, subset_types="all"):
         The hypergraph of interest
     subset_types : str, optional
         Type of relations to include. Options are:
-            "all" : all subset relationships
-            "immediate" : only subset relationships between hyperedges of
-                adjacent sizes (i.e., edges from k to k-1)
-            "empirical" : A relaxation of the "immediate" option where only
-                subset relationships between hyperedges of size k and subsets
-                of maximum size k'<k existing in the hypergraph are included.
-                For example, a hyperedge of size 5 may have no immediate
-                encapsulation relationships with hyperedges of size 4, but may
-                encapsulate hyperedegs of size 3, which will be included if
-                using this setting (whereas relationships with subsets of size 2
-                would not be included).
-
+            
+        * "all" : all subset relationships
+        * "immediate" : only subset relationships between hyperedges of
+        adjacent sizes (i.e., edges from k to k-1)
+        * "empirical" : A relaxation of the "immediate" option where only
+        subset relationships between hyperedges of size k and subsets
+        of maximum size k'<k existing in the hypergraph are included.
+        For example, a hyperedge of size 5 may have no immediate
+        encapsulation relationships with hyperedges of size 4, but may
+        encapsulate hyperedegs of size 3, which will be included if
+        using this setting (whereas relationships with subsets of size 2
+        would not be included).
+    
     Returns
     -------
     LG : networkx.DiGraph

diff --git a/xgi/core/hypergraph.py b/xgi/core/hypergraph.py
@@ -628,7 +628,7 @@ def add_edges_from(self, ebunch_to_add, **attr):
             the same length, i.e. you cannot mix different formats.  The iterables
             containing edge members cannot be strings.
 
-        attr : **kwargs, optional
+        attr : :param `**kwargs`:, optional
             Additional attributes to be assigned to all edges. Attribues specified via
             `ebunch_to_add` take precedence over `attr`.
 

diff --git a/xgi/drawing/draw.py b/xgi/drawing/draw.py
@@ -916,7 +916,7 @@ def draw_simplices(
         for it. By default, True.
     params : dict
         Default parameters. Keys that may be useful to override default settings:
-        
+
         * "min_dyad_lw" (default: 1)
         * "max_dyad_lw" (default: 10)
 
@@ -1323,14 +1323,18 @@ def draw_multilayer(
         Color of the hyperedges.  The accepted formats are the same as
         matplotlib's scatter, with the addition of dict and IDStat.
         Those with colors:
+
         * single color as a string
         * single color as 3- or 4-tuple
         * list of colors of length len(ids)
         * dict of colors containing the `ids` as keys
+
         Those with numerical values (will be mapped to colors):
+
         * array of floats
         * dict of floats containing the `ids` as keys
         * IDStat containing the `ids` as keys
+
         If None (default), color by edge size.
     edge_fc_cmap: matplotlib colormap, optional
         Colormap used to map the edge colors. By default, "crest_r".
@@ -1357,6 +1361,7 @@ def draw_multilayer(
         The separation between layers. Default is 0.4.
     **kwargs : optional args
         Alternate default values. Values that can be overwritten are the following:
+
         * "min_node_size" (default: 10)
         * "max_node_size" (default: 30)
         * "min_node_lw" (default: 2)
@@ -1369,6 +1374,7 @@ def draw_multilayer(
     ax : matplotlib Axes3DSubplot
         The subplot with the multilayer network visualization.
     collections : a tuple of 2 collections:
+    
         * node_collection : matplotlib PathCollection
             Collection containing the nodes one the top layer
         * edge_collection : matplotlib PathCollection
@@ -1763,14 +1769,13 @@ def draw_bipartite(
     -------
     ax : matplotlib.pyplot.axes
         The axes corresponding the visualization
-    collections : a tuple of 3 collections:
+    collections : a tuple of 3 collections
 
         * node_collection : matplotlib PathCollection
             Collection containing the nodes
         * edge_marker_collection : matplotlib PathCollection
             Collection containing the edge markers
-        * dyad_collection : matplotlib LineCollection if undirected,
-                            list of FancyArrowPatches if not
+        * dyad_collection : matplotlib LineCollection if undirected, list of FancyArrowPatches if not
             Collection containing the edges
 
     Raises