Cleanup docs on reading shape files to avoid user confusion #783
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
ethanwhite
commented
Sep 16, 2024
ethanwhite
commented
- Clearly show reading files from a path without complexity of temp dirs and format strings from the tests
- Remove unnecessary local shell command
The docs showed reading a file from a tmpdir using the previous generation of format strings. This is confusing to users (see weecology#781). Fixes weecology#781
OS specific shell commands with local path information can be confusing to users. This removes that command the just shows the output (the structure of the csv file) which is all the user needs to understand the behavior of the documented functions.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.