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

improve docstring of pathof #28817

Merged
merged 2 commits into from
Aug 26, 2018
Merged

improve docstring of pathof #28817

merged 2 commits into from
Aug 26, 2018

Conversation

jannefiluren
Copy link
Contributor

Added references to dirname and basename to the docstring of pathof. It was not immediately clear to me how to use the results of pathof without knowing the existence of dirname. Could simplify this pr to just show See also dirname and basename.

@stevengj
Copy link
Member

CI failures seem unrelated?

@mbauman mbauman added the docs This change adds or pertains to documentation label Aug 23, 2018
@mbauman
Copy link
Member

mbauman commented Aug 23, 2018

Nope, they're very related:

+ gmake check-whitespace
base/loading.jl:258:Use [`dirname`](@ref) to get the directory part and [`basename`](@ref) 
Error: trailing whitespace found in source file(s)
This can often be fixed with:
    git rebase --whitespace=fix HEAD~1
or
    git rebase --whitespace=fix master
and then a forced push of the correct branch
gmake: *** [Makefile:92: check-whitespace] Error 1

@KristofferC KristofferC mentioned this pull request Aug 24, 2018
@KristofferC KristofferC merged commit 304cbd9 into JuliaLang:master Aug 26, 2018
KristofferC pushed a commit that referenced this pull request Aug 26, 2018
* improve docstring of pathof

(cherry picked from commit 304cbd9)
KristofferC pushed a commit that referenced this pull request Sep 8, 2018
* improve docstring of pathof

(cherry picked from commit 304cbd9)
KristofferC pushed a commit that referenced this pull request Sep 8, 2018
* improve docstring of pathof

(cherry picked from commit 304cbd9)
KristofferC pushed a commit that referenced this pull request Feb 11, 2019
* improve docstring of pathof

(cherry picked from commit 304cbd9)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants