summaryrefslogtreecommitdiff
path: root/doc/reference
diff options
context:
space:
mode:
authorDanny Niquette <bigdniquette@gmail.com>2020-07-26 11:40:56 -0700
committerGitHub <noreply@github.com>2020-07-26 11:40:56 -0700
commitf5fd2e6e2acb60dd531dd39503bc44d637a97e85 (patch)
tree5488f0faefdddcf5c62421b3109847a859e0ed63 /doc/reference
parent0f652331a4affc8912c80d84611a71e5a7921983 (diff)
downloadnetworkx-f5fd2e6e2acb60dd531dd39503bc44d637a97e85.tar.gz
Add function to calculate path cost for a specified path (#4069)
* Began writing function for specified path cost and associated tests * Cleaned up formatting and finished writing test * Made minor changes as suggested in PR comment. Name changes and syntax changes * polished up and wrote tests for is_path, adjusted tests to include Digraph and MultiDiGraph, added sphinx shorthand in docs * Fixed most pep8 warnings (excluding line too long) * Updated docstring and fixed is_path to have lower memory footprint * minor tweaks to allow rebase * Add credits for contributor * Run black Co-authored-by: DNiquette16 <Dniquette16@gmail.com> Co-authored-by: Dan Schult <dschult@colgate.edu> Co-authored-by: Jarrod Millman <jarrod.millman@gmail.com>
Diffstat (limited to 'doc/reference')
-rw-r--r--doc/reference/functions.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/reference/functions.rst b/doc/reference/functions.rst
index db7eaab8..04ad1e57 100644
--- a/doc/reference/functions.rst
+++ b/doc/reference/functions.rst
@@ -73,6 +73,13 @@ Attributes
set_edge_attributes
get_edge_attributes
+Paths
+----------
+.. autosummary::
+ :toctree: generated/
+
+ is_path
+ path_weight
Freezing graph structure
------------------------