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.

Sign up for GitHub

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

Jump to bottom

Fix return type docstring for realpath and homedir #33492

Merged
merged 1 commit into from
Oct 8, 2019
Merged

Fix return type docstring for realpath and homedir #33492

merged 1 commit into from
Oct 8, 2019

Conversation

musm
Copy link
Contributor

@musm musm commented Oct 7, 2019

Both of these functions return the concrete String type.

StefanKarpinski
StefanKarpinski approved these changes Oct 7, 2019
View reviewed changes
Copy link
Member

@StefanKarpinski StefanKarpinski left a comment

Choose a reason for hiding this comment

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

They weren't wrong before, just less precise than possible.

@musm
Copy link
Contributor Author

musm commented Oct 7, 2019

True, not sure if this change is "worth-it" (but these are 100% guaranteed to return String since they call libuv and we don't then convert back to the input type). In fact a lot of the other function in path.jl also always return String, but I didn't carefully audit every single function.
Do we have a policy on this?

@KristofferC KristofferC merged commit 76d9b4b into JuliaLang:master Oct 8, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@StefanKarpinski StefanKarpinski StefanKarpinski approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@musm @StefanKarpinski @KristofferC