summaryrefslogtreecommitdiff
path: root/networkx/drawing
diff options
context:
space:
mode:
authorSultan Orazbayev <contact@econpoint.com>2022-12-06 11:56:53 +0600
committerGitHub <noreply@github.com>2022-12-05 21:56:53 -0800
commit9c79d7d37cd6d464d0592fd9138d58b252f9b4be (patch)
tree7761bea9d8685e01ef5a14e3a1e86a031e5d23a3 /networkx/drawing
parente162f303fc8c7dbabd4f30d7e75f43a124e1bdfb (diff)
downloadnetworkx-9c79d7d37cd6d464d0592fd9138d58b252f9b4be.tar.gz
doc: clarify allowed `alpha` when using nx.draw_networkx_edges (#6254)
* doc: clarify allowed `alpha` when using nx.draw_networkx_edges Co-authored-by: Ross Barnowski <rossbar@berkeley.edu>
Diffstat (limited to 'networkx/drawing')
-rw-r--r--networkx/drawing/nx_pylab.py7
1 files changed, 5 insertions, 2 deletions
diff --git a/networkx/drawing/nx_pylab.py b/networkx/drawing/nx_pylab.py
index 674c28a4..61030b1a 100644
--- a/networkx/drawing/nx_pylab.py
+++ b/networkx/drawing/nx_pylab.py
@@ -522,8 +522,11 @@ def draw_networkx_edges(
Also, `(offset, onoffseq)` tuples can be used as style instead of a strings.
(See `matplotlib.patches.FancyArrowPatch`: `linestyle`)
- alpha : float or None (default=None)
- The edge transparency
+ alpha : float or array of floats (default=None)
+ The edge transparency. This can be a single alpha value,
+ in which case it will be applied to all specified edges. Otherwise,
+ if it is an array, the elements of alpha will be applied to the colors
+ in order (cycling through alpha multiple times if necessary).
edge_cmap : Matplotlib colormap, optional
Colormap for mapping intensities of edges