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

Docs: include top-level module documentation in helpdb.jl #3911

Closed
kmsquire opened this issue Aug 1, 2013 · 6 comments
Closed

Docs: include top-level module documentation in helpdb.jl #3911

kmsquire opened this issue Aug 1, 2013 · 6 comments
Labels
docs This change adds or pertains to documentation

Comments

@kmsquire
Copy link
Member

kmsquire commented Aug 1, 2013

Top-level documentation exists for a number of modules in Base, including Sort, Profile, Collections, and Test, but that documentation does not appear in helpdb.jl (cf. #2242). It would be nice to include it.

(Hopefully this issue will be superseded by an upgraded documentation system.)

Edit: To clarify, the submodule function documentation is included, but no help is available for the modules themselves:

julia> help(Profile)
No help information found.

julia> help(Base.Profile)
No help information found.
@timholy
Copy link
Member

timholy commented Aug 1, 2013

Not quite:

julia> help("@profile")
Loading help data...
Base.@profile()

   "@profile <expression>" runs your expression while taking
   periodic backtraces.  These are appended to an internal buffer of
   backtraces.

julia> help(Profile.print)
Base.print(x)

   Write (to the default output stream) a canonical (un-decorated)
   text representation of a value if there is one, otherwise call
   "show".

Base.Profile.print([io::IO = STDOUT], [data::Vector]; format = :tree, C = false, combine = true, cols = tty_cols())

   Prints profiling results to "io" (by default, "STDOUT"). If you
   do not supply a "data" vector, the internal buffer of accumulated
   backtraces will be used.  "format" can be ":tree" or ":flat".
   If "C==true", backtraces from C and Fortran code are shown.
   "combine==true" merges instruction pointers that correspond to
   the same line of code.  "cols" controls the width of the display.

Base.Profile.print([io::IO = STDOUT], data::Vector, lidict::Dict; format = :tree, combine = true, cols = tty_cols())

   Prints profiling results to "io". This variant is used to examine
   results exported by a previous call to "Profile.retrieve()".
   Supply the vector "data" of backtraces and a dictionary
   "lidict" of line information.

@kmsquire
Copy link
Member Author

kmsquire commented Aug 1, 2013

Sorry, wasn't clear. Clarified in the text, but basically,

julia> help(Profile)
No help information found.

julia> help(Base.Profile)
No help information found.

@nolta
Copy link
Member

nolta commented Aug 1, 2013

What do you want help(FFTW) help(Sort) to print out? The entire manual page?

@kmsquire
Copy link
Member Author

kmsquire commented Aug 2, 2013

No, just what's at the top of the sort.rst file.

@nolta
Copy link
Member

nolta commented Aug 2, 2013

Ok. But this brings up the larger question of why are we exporting Sort in the first place? Isn't the importall .Sort sufficient?

@jakebolewski
Copy link
Member

This doesn't seem relevant anymore.

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