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

Ambigous meaning for parameter fileName in introprog.IO #14

Open
wudse20 opened this issue Dec 17, 2020 · 2 comments
Open

Ambigous meaning for parameter fileName in introprog.IO #14

wudse20 opened this issue Dec 17, 2020 · 2 comments
Assignees

Comments

@wudse20
Copy link
Contributor

wudse20 commented Dec 17, 2020

The documentation in the file introprog.IO for the parameter fileName is a bit ambiguous. After trying to use this library myself and after reading in the course forum in the channel frågor-och-svar, I’ve come to the conclusion that it probably should be renamed to path or add documentation to explain that it’s the path of the file and not just the file name.

bjornregnell added a commit that referenced this issue Dec 19, 2020
Improvements in the documentation of `introprog.IO`. #14
@bjornregnell
Copy link
Member

Yes,file is probably a better param name than fileName. @jos-rosenqvist-3812 What do you think? Maybe this PR #15 with doc improvement helps to clear the ambiguity enough to make it less urgent to change the param name? After all param name changes can break existing client code and requires update of all examples etc...

@bjornregnell
Copy link
Member

A global search on fileName (case sensitive, whole word) in the introprog repo gives 158 ! occurences of fileName so this change is heavy and needs some careful reviewing.

@bjornregnell bjornregnell self-assigned this Jun 11, 2024
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

2 participants