Closed LeoniePhiline closed 1 year ago
It's not a big deal - it's just correcting something that's wrong.
Even if it being wrong does no further harm than to trip the occasional reader's brain for a second.
Sometimes it's the small things. ;)
No, thank you. It does make for cleaner docs.
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.