summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRoss Barnowski <rossbar@berkeley.edu>2023-04-03 12:44:39 -0700
committerGitHub <noreply@github.com>2023-04-03 15:44:39 -0400
commit020eaf626d6252f71a75751f63c57cbcc3d55573 (patch)
tree814c7eb9000cc66544526c3c976fe3e42a5d1259
parentcf7158efc5261a49d0cf9f10a09ff51aeb831c30 (diff)
downloadnetworkx-020eaf626d6252f71a75751f63c57cbcc3d55573.tar.gz
Fix module docstring format for ismags reference article. (#6611)
Improperly formatted Notes/References sections was causing a sphinx parsing error which led to a very poorly formatted html page. Fixing the numpydoc formatting for the module docstring + minor munging of the heading levels was sufficient to fix this.
-rw-r--r--doc/reference/algorithms/isomorphism.ismags.rst4
-rw-r--r--networkx/algorithms/isomorphism/ismags.py27
2 files changed, 13 insertions, 18 deletions
diff --git a/doc/reference/algorithms/isomorphism.ismags.rst b/doc/reference/algorithms/isomorphism.ismags.rst
index d9d19cae..67cc9b91 100644
--- a/doc/reference/algorithms/isomorphism.ismags.rst
+++ b/doc/reference/algorithms/isomorphism.ismags.rst
@@ -1,9 +1,5 @@
.. _ismags:
-****************
-ISMAGS Algorithm
-****************
-
.. automodule:: networkx.algorithms.isomorphism.ismags
ISMAGS object
diff --git a/networkx/algorithms/isomorphism/ismags.py b/networkx/algorithms/isomorphism/ismags.py
index 76fdee05..25ce94c8 100644
--- a/networkx/algorithms/isomorphism/ismags.py
+++ b/networkx/algorithms/isomorphism/ismags.py
@@ -1,7 +1,6 @@
"""
-****************
ISMAGS Algorithm
-****************
+================
Provides a Python implementation of the ISMAGS algorithm. [1]_
@@ -90,21 +89,21 @@ True
Notes
-----
- - The current implementation works for undirected graphs only. The algorithm
- in general should work for directed graphs as well though.
- - Node keys for both provided graphs need to be fully orderable as well as
- hashable.
- - Node and edge equality is assumed to be transitive: if A is equal to B, and
- B is equal to C, then A is equal to C.
+- The current implementation works for undirected graphs only. The algorithm
+ in general should work for directed graphs as well though.
+- Node keys for both provided graphs need to be fully orderable as well as
+ hashable.
+- Node and edge equality is assumed to be transitive: if A is equal to B, and
+ B is equal to C, then A is equal to C.
References
----------
- .. [1] M. Houbraken, S. Demeyer, T. Michoel, P. Audenaert, D. Colle,
- M. Pickavet, "The Index-Based Subgraph Matching Algorithm with General
- Symmetries (ISMAGS): Exploiting Symmetry for Faster Subgraph
- Enumeration", PLoS One 9(5): e97896, 2014.
- https://doi.org/10.1371/journal.pone.0097896
- .. [2] https://en.wikipedia.org/wiki/Maximum_common_induced_subgraph
+.. [1] M. Houbraken, S. Demeyer, T. Michoel, P. Audenaert, D. Colle,
+ M. Pickavet, "The Index-Based Subgraph Matching Algorithm with General
+ Symmetries (ISMAGS): Exploiting Symmetry for Faster Subgraph
+ Enumeration", PLoS One 9(5): e97896, 2014.
+ https://doi.org/10.1371/journal.pone.0097896
+.. [2] https://en.wikipedia.org/wiki/Maximum_common_induced_subgraph
"""
__all__ = ["ISMAGS"]