From 90027d6b2d535893f9f06b1085d00933163f05e0 Mon Sep 17 00:00:00 2001 From: Jeff Bezanson Date: Tue, 3 Sep 2013 14:38:47 -0400 Subject: [PATCH] close #2242 --- doc/DocCheck.jl | 2 +- doc/UNDOCUMENTED.rst | 12 --------- doc/helpdb.jl | 58 ++++++++++++++++++++++++++++++++++++++++---- doc/stdlib/base.rst | 16 +++++++++++- 4 files changed, 69 insertions(+), 19 deletions(-) diff --git a/doc/DocCheck.jl b/doc/DocCheck.jl index de0082032eb8f..4091c837d8223 100644 --- a/doc/DocCheck.jl +++ b/doc/DocCheck.jl @@ -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 diff --git a/doc/UNDOCUMENTED.rst b/doc/UNDOCUMENTED.rst index 3f8ff3d22ac85..b131c7dc735ed 100644 --- a/doc/UNDOCUMENTED.rst +++ b/doc/UNDOCUMENTED.rst @@ -73,18 +73,10 @@ scalar math specfun ------- -.. function:: besselh(...) - - UNDOCUMENTED - arrays ------ -.. function:: gradient(...) - - UNDOCUMENTED - linear algebra -------------- @@ -108,10 +100,6 @@ collections strings and text output ----------------------- -.. function:: xdump(...) - - UNDOCUMENTED - random numbers -------------- diff --git a/doc/helpdb.jl b/doc/helpdb.jl index a0f1e86a59d2c..6a2df8f8a7102 100644 --- a/doc/helpdb.jl +++ b/doc/helpdb.jl @@ -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 @@ -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. "), @@ -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\", @@ -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 + +"), + +("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\". @@ -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\" "), @@ -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. diff --git a/doc/stdlib/base.rst b/doc/stdlib/base.rst index 6ffb7db87d44b..65b9a5ec57210 100644 --- a/doc/stdlib/base.rst +++ b/doc/stdlib/base.rst @@ -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) @@ -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)`. @@ -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.