Skip to content

Commit

Permalink
close #2242
Browse files Browse the repository at this point in the history
  • Loading branch information
JeffBezanson committed Sep 3, 2013
1 parent 4012427 commit 90027d6
Show file tree
Hide file tree
Showing 4 changed files with 69 additions and 19 deletions.
2 changes: 1 addition & 1 deletion doc/DocCheck.jl
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ function _undocumented_rst()
isdeprecated(m,s) && continue
havecount+=1; total+=1; continue
end
add!(undoc_exports, line)
push!(undoc_exports, line)
if line[1]=='@'; line = line[2:end] end
line=string("- [ ] ", line)
total+=1
Expand Down
12 changes: 0 additions & 12 deletions doc/UNDOCUMENTED.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,18 +73,10 @@ scalar math
specfun
-------

.. function:: besselh(...)

UNDOCUMENTED


arrays
------

.. function:: gradient(...)

UNDOCUMENTED


linear algebra
--------------
Expand All @@ -108,10 +100,6 @@ collections
strings and text output
-----------------------

.. function:: xdump(...)

UNDOCUMENTED


random numbers
--------------
Expand Down
58 changes: 53 additions & 5 deletions doc/helpdb.jl
Original file line number Diff line number Diff line change
Expand Up @@ -1940,7 +1940,7 @@
"),

("I/O","Base","redirect_stderr","redirect_stderr([stream])
("I/O","Base","redirect_stdin","redirect_stdin([stream])
Like redirect_stdout, but for STDIN. Note that the order of the
return tuple is still (rd,wr), i.e. data to be read from STDIN, may
Expand Down Expand Up @@ -2319,8 +2319,13 @@

("Text I/O","Base","dump","dump(x)
Show the full structure of a value, including all fields of
objects.
Show all user-visible structure of a value.
"),

("Text I/O","Base","xdump","xdump(x)
Show all structure of a value, including all fields of objects.
"),

Expand Down Expand Up @@ -3936,6 +3941,14 @@ popdisplay(d::Display)
"),

("Mathematical Functions","Base","besselh","besselh(nu, k, x)
Bessel function of the third kind of order \"nu\" (Hankel
function). \"k\" is either 1 or 2, selecting \"hankelh1\" or
\"hankelh2\", respectively.
"),

("Mathematical Functions","Base","besseli","besseli(nu, x)
Modified Bessel function of the first kind of order \"nu\",
Expand Down Expand Up @@ -4438,6 +4451,34 @@ popdisplay(d::Display)
"),

("Numbers","Base","get_rounding","get_rounding()
Get the current floating point rounding mode. Valid modes are
\"RoundNearest\", \"RoundToZero\", \"RoundUp\" and \"RoundDown\".
"),

("Numbers","Base","set_rounding","set_rounding(mode)
Set the floating point rounding mode. See \"get_rounding\" for
available modes
"),

This comment has been minimized.

Copy link
@vtjnash

vtjnash Sep 3, 2013

Member

Is with_rounding (or even, can it be) task-local?

This comment has been minimized.

Copy link
@JeffBezanson

JeffBezanson Sep 3, 2013

Author Member

That's a good point; it would probably be a good thing, but it could add significant overhead and/or complexity.

This comment has been minimized.

Copy link
@vtjnash

vtjnash Sep 3, 2013

Member

Can you open a real issue # for this so it can be tracked eventually

("Numbers","Base","with_rounding","with_rounding(f::Function, mode)
Change the floating point rounding mode for the duration of \"f\".
It is logically equivalent to:
old = get_rounding()
set_rounding(mode)
f()
set_rounding(old)
See \"get_rounding\" for available rounding modes.
"),

("Numbers","Base","count_ones","count_ones(x::Integer) -> Integer
Number of ones in the binary representation of \"x\".
Expand Down Expand Up @@ -4552,8 +4593,8 @@ popdisplay(d::Display)
("BigFloats","Base","get_bigfloat_rounding","get_bigfloat_rounding()
Get the current BigFloat rounding mode. Valid modes are
\"RoundToNearest\", \"RoundToZero\", \"RoundUp\", \"RoundDown\",
\"RoundAwayZero\"
\"RoundNearest\", \"RoundToZero\", \"RoundUp\", \"RoundDown\",
\"RoundFromZero\"
"),

Expand Down Expand Up @@ -5166,6 +5207,13 @@ popdisplay(d::Display)
"),

("Arrays","Base","gradient","gradient(F[, h])
Compute differences along vector \"F\", using \"h\" as the spacing
between points. The default spacing is one.
"),

("Arrays","Base","rot180","rot180(A)
Rotate matrix \"A\" 180 degrees.
Expand Down
16 changes: 15 additions & 1 deletion doc/stdlib/base.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1504,7 +1504,11 @@ Text I/O

.. function:: dump(x)

Show the full structure of a value, including all fields of objects.
Show all user-visible structure of a value.

.. function:: xdump(x)

Show all structure of a value, including all fields of objects.

.. function:: readall(stream)

Expand Down Expand Up @@ -2667,6 +2671,11 @@ Mathematical Functions

Bessel function of the third kind of order ``nu``, :math:`H^{(2)}_\nu(x)`.

.. function:: besselh(nu, k, x)

Bessel function of the third kind of order ``nu`` (Hankel function).
``k`` is either 1 or 2, selecting ``hankelh1`` or ``hankelh2``, respectively.

.. function:: besseli(nu, x)

Modified Bessel function of the first kind of order ``nu``, :math:`I_\nu(x)`.
Expand Down Expand Up @@ -3475,6 +3484,11 @@ Array functions

Finite difference operator of matrix or vector.

.. function:: gradient(F, [h])

Compute differences along vector ``F``, using ``h`` as the spacing between points.
The default spacing is one.

.. function:: rot180(A)

Rotate matrix ``A`` 180 degrees.
Expand Down

1 comment on commit 90027d6

@vtjnash
Copy link
Member

@vtjnash vtjnash commented on 90027d6 Sep 3, 2013

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome!

Please sign in to comment.