Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Vector Stream Network Analysis argument mismatch in documentation #410

Open
brownag opened this issue May 25, 2024 · 0 comments
Open

Vector Stream Network Analysis argument mismatch in documentation #410

brownag opened this issue May 25, 2024 · 0 comments

Comments

@brownag
Copy link
Contributor

brownag commented May 25, 2024

While rebuilding whitebox R package I noticed that there is a mismatch in the function definition vs. the documentation for the vector_stream_network_analysis tool.

whitebox-tools/whitebox_tools.py

Lines 10655 to 10672 in 161cb56

def vector_stream_network_analysis(self, streams, output, snap=0.1, callback=None):
"""This tool performs common stream network analysis operations on an input vector stream file.
Keyword arguments:
streams -- Name of the input streams vector file.
dem -- Name of the input DEM raster file.
output -- Name of the output lines shapefile.
cutting_height -- Maximum ridge-cutting height (z units).
snap -- Snap distance, in xy units (metres).
callback -- Custom function for handling tool text outputs.
"""
args = []
args.append("--streams='{}'".format(streams))
args.append("--dem='{}'".format(dem))
args.append("--output='{}'".format(output))
args.append("--cutting_height={}".format(cutting_height))
args.append("--snap={}".format(snap))

It appears that the manual has been updated to reflect that dem and cutting_height are no longer used, but the parameters are still passed to the tool function:

8068c98#diff-d8908e52c22b4d560d071d8aefa862434a48304843a38b2b25b58d8f5c9cfb73

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant