fix(docs): Change dir
and file
variable names ...
#237
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.
fix(docs): Change
dir
andfile
variable names intempdir
andtempdir_in
documentationto match existing comments and rest of module
Problem statement
The documentation for tempdir and tempdir_in use variables
dir
andfile
but refer to them astmp_dir
andtmp_file
in code comments.Discussion
The comments could be changed to refer to
dir
andfile
. However, the rest of the module usestmp_dir
andtmp_file
.PR changes
The variable names were changed.
This way, they match the comments referring to these variables as well as the rest of the module documentation.
Tests
Existing doctests succeed.