diff options
| author | Moradnejad <i.moradnejad@gmail.com> | 2019-02-18 13:16:42 +0330 |
|---|---|---|
| committer | Dan Schult <dschult@colgate.edu> | 2019-02-18 20:46:42 +1100 |
| commit | 2db5f8663deacc501c7472c3a60884a2ca8be45a (patch) | |
| tree | 80a0ef1bc5c0596963dfc4e65a708d67dba68004 /networkx/algorithms/components | |
| parent | e02d18cbbc83e97a21a1255acd6948b19ced28a1 (diff) | |
| download | networkx-2db5f8663deacc501c7472c3a60884a2ca8be45a.tar.gz | |
Replacing `Return` to `Returns` in docs for functions (#3301)
* Fixed problem in documentation view of this function
* Replacing `Return` to `Returns` in function docs
Diffstat (limited to 'networkx/algorithms/components')
5 files changed, 9 insertions, 9 deletions
diff --git a/networkx/algorithms/components/biconnected.py b/networkx/algorithms/components/biconnected.py index c30d0d55..3197428c 100644 --- a/networkx/algorithms/components/biconnected.py +++ b/networkx/algorithms/components/biconnected.py @@ -26,7 +26,7 @@ __all__ = [ @not_implemented_for('directed') def is_biconnected(G): - """Return True if the graph is biconnected, False otherwise. + """Returns True if the graph is biconnected, False otherwise. A graph is biconnected if, and only if, it cannot be disconnected by removing only one node (and all edges incident on that node). If @@ -99,7 +99,7 @@ def is_biconnected(G): @not_implemented_for('directed') def biconnected_component_edges(G): - """Return a generator of lists of edges, one list for each biconnected + """Returns a generator of lists of edges, one list for each biconnected component of the input graph. Biconnected components are maximal subgraphs such that the removal of a @@ -172,7 +172,7 @@ def biconnected_component_edges(G): @not_implemented_for('directed') def biconnected_components(G): - """Return a generator of sets of nodes, one set for each biconnected + """Returns a generator of sets of nodes, one set for each biconnected component of the graph Biconnected components are maximal subgraphs such that the removal of a diff --git a/networkx/algorithms/components/connected.py b/networkx/algorithms/components/connected.py index c94b3db3..f063254e 100644 --- a/networkx/algorithms/components/connected.py +++ b/networkx/algorithms/components/connected.py @@ -92,7 +92,7 @@ def connected_component_subgraphs(G, copy=True): def number_connected_components(G): - """Return the number of connected components. + """Returns the number of connected components. Parameters ---------- @@ -120,7 +120,7 @@ def number_connected_components(G): @not_implemented_for('directed') def is_connected(G): - """Return True if the graph is connected, False otherwise. + """Returns True if the graph is connected, False otherwise. Parameters ---------- @@ -164,7 +164,7 @@ def is_connected(G): @not_implemented_for('directed') def node_connected_component(G, n): - """Return the set of nodes in the component of graph containing node n. + """Returns the set of nodes in the component of graph containing node n. Parameters ---------- diff --git a/networkx/algorithms/components/semiconnected.py b/networkx/algorithms/components/semiconnected.py index 2c4f191c..72db592d 100644 --- a/networkx/algorithms/components/semiconnected.py +++ b/networkx/algorithms/components/semiconnected.py @@ -16,7 +16,7 @@ __all__ = ['is_semiconnected'] @not_implemented_for('undirected') def is_semiconnected(G): - """Return True if the graph is semiconnected, False otherwise. + """Returns True if the graph is semiconnected, False otherwise. A graph is semiconnected if, and only if, for any pair of nodes, either one is reachable from the other, or they are mutually reachable. diff --git a/networkx/algorithms/components/strongly_connected.py b/networkx/algorithms/components/strongly_connected.py index 1741d4ea..67b281af 100644 --- a/networkx/algorithms/components/strongly_connected.py +++ b/networkx/algorithms/components/strongly_connected.py @@ -287,7 +287,7 @@ def strongly_connected_component_subgraphs(G, copy=True): @not_implemented_for('undirected') def number_strongly_connected_components(G): - """Return number of strongly connected components in graph. + """Returns number of strongly connected components in graph. Parameters ---------- diff --git a/networkx/algorithms/components/weakly_connected.py b/networkx/algorithms/components/weakly_connected.py index 4a041a92..7bf348c7 100644 --- a/networkx/algorithms/components/weakly_connected.py +++ b/networkx/algorithms/components/weakly_connected.py @@ -76,7 +76,7 @@ def weakly_connected_components(G): @not_implemented_for('undirected') def number_weakly_connected_components(G): - """Return the number of weakly connected components in G. + """Returns the number of weakly connected components in G. Parameters ---------- |