diff options
| author | dschult <none@none> | 2007-02-15 21:47:55 +0000 |
|---|---|---|
| committer | dschult <none@none> | 2007-02-15 21:47:55 +0000 |
| commit | 163eb9036c7897becd71e40c7f61f6606f8afdc9 (patch) | |
| tree | 03e5004f45d88d92f6e410b7170fc9223be270b6 | |
| parent | 5564390cc4f97339568d28146c6c8ee87516b254 (diff) | |
| download | networkx-163eb9036c7897becd71e40c7f61f6606f8afdc9.tar.gz | |
Documentation changes to announce more obviously that
for DiGraph/XDiGraph, neighbors is outoging neighbors only.
I looked through docstrings too, but it seems pretty clear there.
fixes #84
--HG--
extra : convert_revision : svn%3A3ed01bd8-26fb-0310-9e4c-ca1a4053419f/networkx/trunk%40530
| -rw-r--r-- | doc/Overview.txt | 2 | ||||
| -rw-r--r-- | doc/Quick_ref.txt | 4 | ||||
| -rw-r--r-- | doc/Tutorial.txt | 8 |
3 files changed, 7 insertions, 7 deletions
diff --git a/doc/Overview.txt b/doc/Overview.txt index 01794fc1..83767695 100644 --- a/doc/Overview.txt +++ b/doc/Overview.txt @@ -91,7 +91,7 @@ obtained through methods as well as functions. These are:: - G.edges(): a list of 2-tuples specifying edges of G. - G.edges_iter(): an iterator over the edges (as 2-tuples) of G. - G.has_edge(u,v): check if edge (u,v) in G (returns True or False). - - G.neighbors(v): list of the neighbors of node v. + - G.neighbors(v): list of the neighbors of node v (outgoing if directed). - G.neighbors_iter(v): an iterator over the neighbors of node v. - G.degree(): list of the degree of each node. - G.degree_iter(): an iterator over the degrees of the nodes in G. diff --git a/doc/Quick_ref.txt b/doc/Quick_ref.txt index 1c5a22a0..f4c08618 100644 --- a/doc/Quick_ref.txt +++ b/doc/Quick_ref.txt @@ -127,7 +127,7 @@ Methods: G.edge_boundary(nb1) - return a list of edges outward from nb1. G.edge_boundary(nb1,nb2) - return a list of edges between nb1 and nb2. - G.neighbors(n) - return list of nodes connected to node n. + G.neighbors(n) - return list of nodes connected to node n (outgoing if directed). G[n] - equivalent to G.neighbors(n). G.neighbors_iter(n) - return iterator over the neighbors of node n. G.has_neighbor(v,u) - check if u is a neighbor of v (returns True or False). @@ -200,7 +200,7 @@ Nodal Properties :: - neighbors(G,n) - neighbors of n in G. + neighbors(G,n) - neighbors (outgoing if directed) of n in G. G[n] - same as above. degree(G,n) - number of edges for n in G. eccentricity(G,n) - maximum of shortest-path lengths from n to anywhere in G. diff --git a/doc/Tutorial.txt b/doc/Tutorial.txt index db286919..4da0632d 100644 --- a/doc/Tutorial.txt +++ b/doc/Tutorial.txt @@ -572,10 +572,10 @@ methods to those of Graph: - out_edges_iter - in_edges - in_edges_iter - - successors=in_neighbors=neighbors - - successors_iter=in_neighbors_iter=neighbors_iter - - predecessors=out_neighbors - - predecessors_iter=out_neighbors_iter + - successors=out_neighbors=neighbors + - successors_iter=out_neighbors_iter=neighbors_iter + - predecessors=in_neighbors + - predecessors_iter=in_neighbors_iter - out_degree - out_degree_iter - in_degree |