summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaula PĂ©rez Bianchi <44149844+paulitapb@users.noreply.github.com>2023-02-03 13:04:55 -0300
committerGitHub <noreply@github.com>2023-02-03 11:04:55 -0500
commitf2b337f1a4e37aa65766dd1638dc9c09a97d2687 (patch)
tree5b050dbb2cf227b99baa65289f1e7e09f42f41be
parent352a38710308067d655d4d0c980d1321475000d5 (diff)
downloadnetworkx-f2b337f1a4e37aa65766dd1638dc9c09a97d2687.tar.gz
Delete warning in approximation documentation (#6221)
* Add warning in community doc * Delete warning in approximation * undo unwanted changes * Minor formatting nits. --------- Co-authored-by: Ross Barnowski <rossbar@berkeley.edu>
-rw-r--r--networkx/algorithms/approximation/__init__.py10
1 files changed, 5 insertions, 5 deletions
diff --git a/networkx/algorithms/approximation/__init__.py b/networkx/algorithms/approximation/__init__.py
index 13fc21f9..e39dc00a 100644
--- a/networkx/algorithms/approximation/__init__.py
+++ b/networkx/algorithms/approximation/__init__.py
@@ -1,12 +1,12 @@
"""Approximations of graph properties and Heuristic methods for optimization.
- .. warning:: These functions are not imported in the top-level of ``networkx``
+The functions in this class are not imported into the top-level ``networkx``
+namespace so the easiest way to use them is with::
- These functions can be accessed using
- ``networkx.approximation.function_name``
+ >>> from networkx.algorithms import approximation
- They can be imported using ``from networkx.algorithms import approximation``
- or ``from networkx.algorithms.approximation import function_name``
+Another option is to import the specific function with
+``from networkx.algorithms.approximation import function_name``.
"""
from networkx.algorithms.approximation.clustering_coefficient import *