Skip to content

Commit

Permalink
split up plain docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
@jakebolewski
jakebolewski committed Sep 4, 2015
1 parent 802846f commit 446a478
Show file tree
Hide file tree
Showing 14 changed files with 362 additions and 2,029 deletions.
364 changes: 360 additions & 4 deletions base/docs/helpdb.jl
View file

Large diffs are not rendered by default.

420 changes: 0 additions & 420 deletions doc/stdlib/arrays.rst
View file

Large diffs are not rendered by default.

94 changes: 0 additions & 94 deletions doc/stdlib/base.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,12 +86,6 @@ Getting Around

.. Docstring generated from Julia source
.. code-block:: julia
edit(file::AbstractString, [line])
Edit a file optionally providing a line number to edit at. Returns to the julia prompt when you quit the editor.

.. code-block:: julia
edit(function, [types])
Expand All @@ -102,12 +96,6 @@ Getting Around

.. Docstring generated from Julia source
.. code-block:: julia
edit(file::AbstractString, [line])
Edit a file optionally providing a line number to edit at. Returns to the julia prompt when you quit the editor.

.. code-block:: julia
edit(function, [types])
Expand All @@ -128,12 +116,6 @@ Getting Around

.. Docstring generated from Julia source
.. code-block:: julia
less(file::AbstractString, [line])
Show a file using the default pager, optionally providing a starting line number. Returns to the julia prompt when you quit the pager.

.. code-block:: julia
less(function, [types])
Expand All @@ -144,12 +126,6 @@ Getting Around

.. Docstring generated from Julia source
.. code-block:: julia
less(file::AbstractString, [line])
Show a file using the default pager, optionally providing a starting line number. Returns to the julia prompt when you quit the pager.

.. code-block:: julia
less(function, [types])
Expand All @@ -170,12 +146,6 @@ Getting Around

.. Docstring generated from Julia source
.. code-block:: julia
clipboard(x)
Send a printed form of ``x`` to the operating system clipboard ("copy").

.. code-block:: julia
clipboard() -> AbstractString
Expand All @@ -186,12 +156,6 @@ Getting Around

.. Docstring generated from Julia source
.. code-block:: julia
clipboard(x)
Send a printed form of ``x`` to the operating system clipboard ("copy").

.. code-block:: julia
clipboard() -> AbstractString
Expand Down Expand Up @@ -270,14 +234,6 @@ Getting Around

.. Docstring generated from Julia source
.. code-block:: julia
which(f, types)
Returns the method of ``f`` (a ``Method`` object) that would be called for arguments of the given types.

If ``types`` is an abstract type, then the method that would be called by ``invoke`` is returned.

.. code-block:: julia
which(symbol)
Expand All @@ -288,14 +244,6 @@ Getting Around

.. Docstring generated from Julia source
.. code-block:: julia
which(f, types)
Returns the method of ``f`` (a ``Method`` object) that would be called for arguments of the given types.

If ``types`` is an abstract type, then the method that would be called by ``invoke`` is returned.

.. code-block:: julia
which(symbol)
Expand Down Expand Up @@ -1105,18 +1053,6 @@ Syntax

.. Docstring generated from Julia source
.. code-block:: julia
parse(str, start; greedy=true, raise=true)
Parse the expression string and return an expression (which could later be passed to eval for execution). Start is the index of the first character to start parsing. If ``greedy`` is true (default), ``parse`` will try to consume as much input as it can; otherwise, it will stop as soon as it has parsed a valid expression. Incomplete but otherwise syntactically valid expressions will return ``Expr(:incomplete, "(error message)")``\ . If ``raise`` is true (default), syntax errors other than incomplete expressions will raise an error. If ``raise`` is false, ``parse`` will return an expression that will raise an error upon evaluation.

.. code-block:: julia
parse(str; raise=true)
Parse the whole string greedily, returning a single expression. An error is thrown if there are additional characters after the first expression. If ``raise`` is true (default), syntax errors will raise an error; otherwise, ``parse`` will return an expression that will raise an error upon evaluation.

.. code-block:: julia
parse(type, str, [base])
Expand All @@ -1127,18 +1063,6 @@ Syntax

.. Docstring generated from Julia source
.. code-block:: julia
parse(str, start; greedy=true, raise=true)
Parse the expression string and return an expression (which could later be passed to eval for execution). Start is the index of the first character to start parsing. If ``greedy`` is true (default), ``parse`` will try to consume as much input as it can; otherwise, it will stop as soon as it has parsed a valid expression. Incomplete but otherwise syntactically valid expressions will return ``Expr(:incomplete, "(error message)")``\ . If ``raise`` is true (default), syntax errors other than incomplete expressions will raise an error. If ``raise`` is false, ``parse`` will return an expression that will raise an error upon evaluation.

.. code-block:: julia
parse(str; raise=true)
Parse the whole string greedily, returning a single expression. An error is thrown if there are additional characters after the first expression. If ``raise`` is true (default), syntax errors will raise an error; otherwise, ``parse`` will return an expression that will raise an error upon evaluation.

.. code-block:: julia
parse(type, str, [base])
Expand Down Expand Up @@ -1260,12 +1184,6 @@ System

.. Docstring generated from Julia source
.. code-block:: julia
kill(p::Process, signum=SIGTERM)
Send a signal to a process. The default is to terminate the process.

.. code-block:: julia
kill(manager::FooManager, pid::Int, config::WorkerConfig)
Expand Down Expand Up @@ -1944,12 +1862,6 @@ Events

.. Docstring generated from Julia source
.. code-block:: julia
Timer(callback::Function, delay, repeat=0)
Create a timer to call the given callback function. The callback is passed one argument, the timer object itself. The callback will be invoked after the specified initial delay, and then repeating with the given ``repeat`` interval. If ``repeat`` is ``0``\ , the timer is only triggered once. Times are in seconds. A timer is stopped and has its resources freed by calling ``close`` on it.

.. code-block:: julia
Timer(delay, repeat=0)
Expand All @@ -1960,12 +1872,6 @@ Events

.. Docstring generated from Julia source
.. code-block:: julia
Timer(callback::Function, delay, repeat=0)
Create a timer to call the given callback function. The callback is passed one argument, the timer object itself. The callback will be invoked after the specified initial delay, and then repeating with the given ``repeat`` interval. If ``repeat`` is ``0``\ , the timer is only triggered once. Times are in seconds. A timer is stopped and has its resources freed by calling ``close`` on it.

.. code-block:: julia
Timer(delay, repeat=0)
Expand Down
12 changes: 0 additions & 12 deletions doc/stdlib/c.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -148,12 +148,6 @@

.. Docstring generated from Julia source
.. code-block:: julia
copy!(dest, src)
Copy all elements from collection ``src`` to array ``dest``\ . Returns ``dest``\ .

.. code-block:: julia
copy!(dest, do, src, so, N)
Expand All @@ -164,12 +158,6 @@

.. Docstring generated from Julia source
.. code-block:: julia
copy!(dest, src)
Copy all elements from collection ``src`` to array ``dest``\ . Returns ``dest``\ .

.. code-block:: julia
copy!(dest, do, src, so, N)
Expand Down
Loading

0 comments on commit 446a478

Please sign in to comment.