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

Doc hard, and with a vengeance #11943

Merged
merged 10 commits into from
Aug 2, 2015
Merged

Doc hard, and with a vengeance #11943

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
96fd316
fix identation
MikeInnes Jun 30, 2015
4a86729
newdoc.jl generates docs/helpdb.jl
MikeInnes Jun 29, 2015
bc1d852
generate new helpdb
MikeInnes Jul 31, 2015
1d97152
include helpdb.jl
MikeInnes Jul 7, 2015
fa4110d
remove newdoc.jl
MikeInnes Jul 31, 2015
6636796
new doc city: remove traces of the old helpdb.jl
StefanKarpinski Jun 28, 2015
55339fc
further help removals
MikeInnes Jul 31, 2015
be7f7c6
genstdlib.jl regenerates the manual
MikeInnes Jun 30, 2015
dfc7168
regenerate the manual
MikeInnes Jul 31, 2015
b980d09
add stdlib generation to build
MikeInnes Jul 31, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
further help removals
  • Loading branch information
@MikeInnes
MikeInnes committed Jul 31, 2015
commit 55339fca71e643db614c459c55fd742fdef8c4d0
2 changes: 0 additions & 2 deletions base/docs/basedocs.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@ const intro = doc"""
For help on a specific function or macro, type `?` followed
by its name, e.g. `?fft`, `?@time` or `?html`, and press
enter.

You can also use `apropos("...")` to search the documentation.
"""

keywords[:help] = keywords[:?] = keywords[:julia] = keywords[:wtf] = intro
Expand Down
2 changes: 0 additions & 2 deletions base/exports.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1076,7 +1076,6 @@ export
symbol,

# help and reflection
apropos,
current_module,
edit,
code_typed,
Expand All @@ -1086,7 +1085,6 @@ export
code_native,
fullname,
functionloc,
help,
isconst,
isgeneric,
isinteractive,
Expand Down
2 changes: 0 additions & 2 deletions contrib/BBEditTextWrangler-julia.plist
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,6 @@
<string>any</string>
<string>any!</string>
<string>append!</string>
<string>apropos</string>
<string>ascii</string>
<string>asec</string>
<string>asecd</string>
Expand Down Expand Up @@ -497,7 +496,6 @@
<string>hash</string>
<string>haskey</string>
<string>hcat</string>
<string>help</string>
<string>hessfact</string>
<string>hessfact!</string>
<string>hex</string>
Expand Down
1 change: 0 additions & 1 deletion doc/DocCheck.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@

module DocCheck

import Base.Help: init_help, FUNCTION_DICT, MODULE_DICT
import Base: argtype_decl, uncompressed_ast

export isdeprecated, isdocumented, undefined_exports, undocumented, undocumented_by_file, undocumented_rst,
Expand Down
8 changes: 0 additions & 8 deletions doc/stdlib/base.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,14 +98,6 @@ Getting Around

Like ``include``, except reads code from the given string rather than from a file. Since there is no file path involved, no path processing or fetching from node 1 is done.

.. function:: help(name)

Get help for a function. ``name`` can be an object or a string.

.. function:: apropos(string)

Search documentation for functions related to ``string``.

.. function:: which(f, types)

Returns the method of ``f`` (a ``Method`` object) that would be called for arguments of the given types.
Expand Down