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

help for modules #3407

Closed
vtjnash opened this issue Jun 15, 2013 · 7 comments
Closed

help for modules #3407

vtjnash opened this issue Jun 15, 2013 · 7 comments
Labels
docs This change adds or pertains to documentation
Milestone

Comments

@vtjnash
Copy link
Member

vtjnash commented Jun 15, 2013

Expand the help system to parse the full module path of a symbol, so we can have help for things in modules resolved correctly (like Pkg.add).

@ViralBShah
Copy link
Member

+1

@carlobaldassi
Copy link
Member

I may have misunderstood the issue, but isn't this already accomplished by just using the proper module or currentmodule rst directives in the docs? See e.g. the documentation for BLAS functions under doc/stdlib/linalg.rst, which at the REPL give:

julia> help("axpy!")
Base.LinAlg.BLAS.axpy!(n, a, X, incx, Y, incy)

   Overwrite "Y" with "a*X + Y".  Returns "Y".

@ViralBShah
Copy link
Member

This doesn't work:

julia> help("Base.LinAlg.BLAS.axpy!")
Loading help data...
No help information found.

We can then implement, say, help for DataFrames, and register it with the helpdb when the package is loaded, for example.

@carlobaldassi
Copy link
Member

It does work, you need to pull the latest changes with the fixes I just committed:

julia> help("Base.LinAlg.BLAS.axpy!")
Base.LinAlg.BLAS.axpy!(n, a, X, incx, Y, incy)

   Overwrite "Y" with "a*X + Y".  Returns "Y".

Registering help databases for a loaded package was in a pull request from Tim from some time ago, if I remember correctly. It's certainly doable anyway.

@ViralBShah
Copy link
Member

Are you referring to #1619?

I guess we need to locate the module a package is in, and then look for ~/.julia/pkg/doc/helpdb.jl and load it if it is not already loaded. The rest should work with your changes, it seems.

@stevengj
Copy link
Member

stevengj commented Aug 8, 2013

Should be subsumed by #762.

@vtjnash
Copy link
Member Author

vtjnash commented Aug 28, 2013

this has been mostly resolved.

@vtjnash vtjnash closed this as completed Aug 28, 2013
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

No branches or pull requests

4 participants