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

fix(docs): Change dir and file variable names ... #237

Merged
merged 1 commit into from
May 12, 2023

Conversation

LeoniePhiline
Copy link
Contributor

@LeoniePhiline LeoniePhiline commented May 12, 2023

fix(docs): Change dir and file variable names in tempdir and tempdir_in documentation

to match existing comments and rest of module

Problem statement

The documentation for tempdir and tempdir_in use variables dir and file but refer to them as tmp_dir and tmp_file in code comments.

Discussion

The comments could be changed to refer to dir and file. However, the rest of the module uses tmp_dir and tmp_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.

test src/dir.rs - dir::tempdir (line 36) ... ok
test src/dir.rs - dir::tempdir_in (line 85) ... ok

Copy link
Owner

@Stebalien Stebalien left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't really see the point, but there's no reason not to.

@Stebalien Stebalien merged commit a2b45b3 into Stebalien:master May 12, 2023
@LeoniePhiline
Copy link
Contributor Author

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. ;)

@Stebalien
Copy link
Owner

Stebalien commented May 13, 2023 via email

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

Successfully merging this pull request may close these issues.

2 participants