Skip to content

Commit

Permalink
Remove docs for deprecated functions
Browse files Browse the repository at this point in the history
msync, iseltype, inf, nan, complement, complement!
etc etc etc
  • Loading branch information
tkelman committed May 25, 2016
1 parent bce068e commit 3fcea09
Show file tree
Hide file tree
Showing 13 changed files with 23 additions and 128 deletions.
45 changes: 5 additions & 40 deletions base/docs/helpdb/Base.jl
Original file line number Diff line number Diff line change
Expand Up @@ -2901,7 +2901,7 @@ showcompact
isleaftype(T)
Determine whether `T` is a concrete type that can have instances, meaning its only subtypes
are itself and `None` (but `T` itself is not `None`).
are itself and `Union{}` (but `T` itself is not `Union{}`).
"""
isleaftype

Expand Down Expand Up @@ -3967,7 +3967,7 @@ colon
Base64EncodePipe(ostream)
Returns a new write-only I/O stream, which converts any bytes written to it into
base64-encoded ASCII bytes written to `ostream`. Calling `close` on the `Base64Pipe` stream
base64-encoded ASCII bytes written to `ostream`. Calling `close` on the `Base64EncodePipe` stream
is necessary to complete the encoding (but does not close `ostream`).
"""
Base64EncodePipe
Expand Down Expand Up @@ -6324,13 +6324,6 @@ Compute sine of `x`, where `x` is in degrees.
"""
sind

"""
iseltype(A,T)
Tests whether `A` or its elements are of type `T`.
"""
iseltype

"""
min(x, y, ...)
Expand Down Expand Up @@ -7266,13 +7259,6 @@ lexicographically comparable types, and `lexless` will call `lexcmp` by default.
"""
lexcmp

"""
inf(f)
Returns positive infinity of the floating point type `f` or of the same floating point type as `f`.
"""
inf

"""
isupper(c::Union{Char,AbstractString}) -> Bool
Expand Down Expand Up @@ -7638,13 +7624,6 @@ julia> "Hello " * "world"
"""
Base.:(*)(s::AbstractString, t::AbstractString)

"""
complement!(s)
Mutates [`IntSet`](:obj:`IntSet`) `s` into its set-complement.
"""
complement!

"""
slice(A, inds...)
Expand Down Expand Up @@ -7957,13 +7936,6 @@ Cumulative product of `A` along a dimension, storing the result in `B`. The dime
"""
cumprod!

"""
complement(s)
Returns the set-complement of [`IntSet`](:obj:`IntSet`) `s`.
"""
complement

"""
rethrow([e])
Expand Down Expand Up @@ -8598,8 +8570,8 @@ cos
base64encode(args...)
Given a `write`-like function `writefunc`, which takes an I/O stream as its first argument,
`base64(writefunc, args...)` calls `writefunc` to write `args...` to a base64-encoded
string, and returns the string. `base64(args...)` is equivalent to `base64(write, args...)`:
`base64encode(writefunc, args...)` calls `writefunc` to write `args...` to a base64-encoded
string, and returns the string. `base64encode(args...)` is equivalent to `base64encode(write, args...)`:
it converts its arguments into bytes using the standard `write` functions and returns the
base64-encoded string.
"""
Expand Down Expand Up @@ -9528,7 +9500,7 @@ Matrix trace.
trace

"""
runtests([tests=["all"] [, numcores=iceil(Sys.CPU_CORES / 2) ]])
runtests([tests=["all"] [, numcores=ceil(Integer, Sys.CPU_CORES / 2) ]])
Run the Julia unit tests listed in `tests`, which can be either a string or an array of
strings, using `numcores` processors. (not exported)
Expand Down Expand Up @@ -9637,13 +9609,6 @@ Unicode string.)
"""
reverseind

"""
nan(f)
Returns NaN (not-a-number) of the floating point type `f` or of the same floating point type as `f`
"""
nan

"""
float(x)
Expand Down
2 changes: 1 addition & 1 deletion base/unicode/utf8proc.jl
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ export isgraphemebreak
# also exported by Base:
export normalize_string, graphemes, is_assigned_char, charwidth, isvalid,
islower, isupper, isalpha, isdigit, isnumber, isalnum,
iscntrl, ispunct, isspace, isprint, isgraph, isblank
iscntrl, ispunct, isspace, isprint, isgraph

# whether codepoints are valid Unicode scalar values, i.e. 0-0xd7ff, 0xe000-0x10ffff
isvalid(::Type{Char}, ch::Unsigned) = !((ch - 0xd800 < 0x800) | (ch > 0x10ffff))
Expand Down
40 changes: 8 additions & 32 deletions contrib/BBEditTextWrangler-julia.plist
Original file line number Diff line number Diff line change
Expand Up @@ -179,13 +179,11 @@
<string>atreplinit</string>
<string>backtrace</string>
<string>baremodule</string>
<string>base64</string>
<string>base64decode</string>
<string>base64encode</string>
<string>base</string>
<string>basename</string>
<string>begin</string>
<string>beginswith</string>
<string>besselh</string>
<string>besselhx</string>
<string>besseli</string>
Expand Down Expand Up @@ -272,8 +270,6 @@
<string>code_warntype</string>
<string>collect</string>
<string>colon</string>
<string>complement!</string>
<string>complement</string>
<string>complex128</string>
<string>complex32</string>
<string>complex64</string>
Expand Down Expand Up @@ -482,7 +478,6 @@
<string>fullname</string>
<string>function</string>
<string>functionloc</string>
<string>functionlocs</string>
<string>gamma</string>
<string>gc</string>
<string>gc_disable</string>
Expand Down Expand Up @@ -528,7 +523,6 @@
<string>hton</string>
<string>hvcat</string>
<string>hypot</string>
<string>iceil</string>
<string>idct!</string>
<string>idct</string>
<string>identity</string>
Expand All @@ -537,7 +531,6 @@
<string>ifft!</string>
<string>ifft</string>
<string>ifftshift</string>
<string>ifloor</string>
<string>ignorestatus</string>
<string>im</string>
<string>imag</string>
Expand Down Expand Up @@ -578,7 +571,6 @@
<string>ipermute!</string>
<string>ipermutedims</string>
<string>irfft</string>
<string>iround</string>
<string>is_apple</string>
<string>is_assigned_char</string>
<string>is_bsd</string>
Expand All @@ -592,7 +584,6 @@
<string>isascii</string>
<string>isassigned</string>
<string>isbits</string>
<string>isblank</string>
<string>isblockdev</string>
<string>ischardev</string>
<string>iscntrl</string>
Expand All @@ -601,7 +592,6 @@
<string>isdigit</string>
<string>isdir</string>
<string>isdirpath</string>
<string>iseltype</string>
<string>isempty</string>
<string>isequal</string>
<string>iseven</string>
Expand Down Expand Up @@ -660,7 +650,6 @@
<string>isvalid</string>
<string>iswritable</string>
<string>isxdigit</string>
<string>itrunc</string>
<string>join</string>
<string>joinpath</string>
<string>keys</string>
Expand Down Expand Up @@ -759,7 +748,6 @@
<string>module</string>
<string>module_name</string>
<string>module_parent</string>
<string>msync</string>
<string>mtime</string>
<string>muladd</string>
<string>mv</string>
Expand Down Expand Up @@ -885,8 +873,6 @@
<string>radians2degrees</string>
<string>rand!</string>
<string>rand</string>
<string>randbool!</string>
<string>randbool</string>
<string>randcycle</string>
<string>randexp!</string>
<string>randexp</string>
Expand Down Expand Up @@ -1027,7 +1013,6 @@
<string>sinpi</string>
<string>size</string>
<string>sizehint!</string>
<string>sizehint</string>
<string>sizeof</string>
<string>skip</string>
<string>skipchars</string>
Expand Down Expand Up @@ -1144,12 +1129,6 @@
<string>typemin</string>
<string>typeof</string>
<string>ucfirst</string>
<string>uint128</string>
<string>uint16</string>
<string>uint32</string>
<string>uint64</string>
<string>uint8</string>
<string>uint</string>
<string>unescape_string</string>
<string>union!</string>
<string>union</string>
Expand Down Expand Up @@ -1251,7 +1230,6 @@
<string>At_rdiv_Bt</string>
<string>Base64DecodePipe</string>
<string>Base64EncodePipe</string>
<string>Base64Pipe</string>
<string>Base</string>
<string>Bidiagonal</string>
<string>BigFloat</string>
Expand Down Expand Up @@ -1392,8 +1370,6 @@
<string>NaN32</string>
<string>NaN64</string>
<string>NaN</string>
<string>None</string>
<string>Nothing</string>
<string>Nullable</string>
<string>NullException</string>
<string>Number</string>
Expand Down Expand Up @@ -1478,8 +1454,8 @@
<string>SymTridiagonal</string>
<string>Sys</string>
<string>SystemError</string>
<string>TCPSocket</string>
<string>Task</string>
<string>TcpSocket</string>
<string>Test</string>
<string>Text</string>
<string>TextDisplay</string>
Expand All @@ -1492,13 +1468,13 @@
<string>Tuple</string>
<string>Type</string>
<string>TypeError</string>
<string>UdpSocket</string>
<string>Uint128</string>
<string>Uint16</string>
<string>Uint32</string>
<string>Uint64</string>
<string>Uint8</string>
<string>Uint</string>
<string>UDPSocket</string>
<string>UInt128</string>
<string>UInt16</string>
<string>UInt32</string>
<string>UInt64</string>
<string>UInt8</string>
<string>UInt</string>
<string>UnicodeError</string>
<string>UniformScaling</string>
<string>UnionType</string>
Expand Down
6 changes: 3 additions & 3 deletions contrib/julia.lang
Original file line number Diff line number Diff line change
Expand Up @@ -284,8 +284,8 @@
<keyword>Hermitian</keyword>
<keyword>Hessenberg</keyword>
<keyword>IO(Buffer|Stream)?</keyword>
<keyword>IPAddr|IPv[46]</keyword>
<keyword>InetAddr</keyword>
<keyword>IpAddr|IPv[46]</keyword>
<keyword>(Key|Value)Iterator</keyword>
<keyword>LambdaInfo</keyword>
<keyword>LocalProcess</keyword>
Expand Down Expand Up @@ -320,14 +320,14 @@
<keyword>StateUpdate</keyword>
<keyword>StaticVarInfo</keyword>
<keyword>Symbol(Node)?</keyword>
<keyword>TCPSocket</keyword>
<keyword>TTY</keyword>
<keyword>Task</keyword>
<keyword>TcpSocket</keyword>
<keyword>TmStruct</keyword>
<keyword>Top(Node)?</keyword>
<keyword>Triangular</keyword>
<keyword>UV(Handle|PollingWatcher|Stream)</keyword>
<keyword>UdpSocket</keyword>
<keyword>UDPSocket</keyword>
<keyword>Undef(RefTag)?</keyword>
<keyword>VarTable</keyword>
<keyword>Vararg</keyword>
Expand Down
2 changes: 1 addition & 1 deletion contrib/julia.xml
Original file line number Diff line number Diff line change
Expand Up @@ -180,8 +180,8 @@
<item> Symbol </item>
<item> Symmetric </item>
<item> SymTridiagonal </item>
<item> TCPSocket </item>
<item> Task </item>
<item> TcpSocket </item>
<item> TimeoutAsyncWork </item>
<item> TmStruct </item>
<item> Triangular </item>
Expand Down
2 changes: 1 addition & 1 deletion doc/DocCheck.jl
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ function undocumented_by_file(m::Module)
for (f,_) in undocumented(m)
s = string(f)
try
for (file, line) in functionlocs(eval(f))
for (file, line) in map(functionloc,methods(eval(f)))
if startswith(file, JULIA_HOME)
file = replace(file, JULIA_HOME, "\$JULIA_HOME", 1)
end
Expand Down
6 changes: 0 additions & 6 deletions doc/stdlib/arrays.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,6 @@ Basic functions
julia> size(A,3,2)
(4,3)
.. function:: iseltype(A,T)

.. Docstring generated from Julia source
Tests whether ``A`` or its elements are of type ``T``\ .

.. function:: length(A) -> Integer

.. Docstring generated from Julia source
Expand Down
2 changes: 1 addition & 1 deletion doc/stdlib/base.rst
Original file line number Diff line number Diff line change
Expand Up @@ -577,7 +577,7 @@ Types

.. Docstring generated from Julia source
Determine whether ``T`` is a concrete type that can have instances, meaning its only subtypes are itself and ``None`` (but ``T`` itself is not ``None``\ ).
Determine whether ``T`` is a concrete type that can have instances, meaning its only subtypes are itself and ``Union{}`` (but ``T`` itself is not ``Union{}``\ ).

.. function:: typejoin(T, S)

Expand Down
12 changes: 0 additions & 12 deletions doc/stdlib/collections.rst
Original file line number Diff line number Diff line change
Expand Up @@ -968,18 +968,6 @@ Set-Like Collections
Construct the symmetric difference of sets ``s1`` and ``s2``\ , storing the result in ``s1``\ .

.. function:: complement(s)

.. Docstring generated from Julia source
Returns the set-complement of :obj:`IntSet` ``s``\ .

.. function:: complement!(s)

.. Docstring generated from Julia source
Mutates :obj:`IntSet` ``s`` into its set-complement.

.. function:: intersect!(s1, s2)

.. Docstring generated from Julia source
Expand Down
4 changes: 2 additions & 2 deletions doc/stdlib/io-network.rst
Original file line number Diff line number Diff line change
Expand Up @@ -630,7 +630,7 @@ Text I/O

.. Docstring generated from Julia source
Returns a new write-only I/O stream, which converts any bytes written to it into base64-encoded ASCII bytes written to ``ostream``\ . Calling ``close`` on the ``Base64Pipe`` stream is necessary to complete the encoding (but does not close ``ostream``\ ).
Returns a new write-only I/O stream, which converts any bytes written to it into base64-encoded ASCII bytes written to ``ostream``\ . Calling ``close`` on the ``Base64EncodePipe`` stream is necessary to complete the encoding (but does not close ``ostream``\ ).

.. function:: Base64DecodePipe(istream)

Expand All @@ -643,7 +643,7 @@ Text I/O

.. Docstring generated from Julia source
Given a ``write``\ -like function ``writefunc``\ , which takes an I/O stream as its first argument, ``base64(writefunc, args...)`` calls ``writefunc`` to write ``args...`` to a base64-encoded string, and returns the string. ``base64(args...)`` is equivalent to ``base64(write, args...)``\ : it converts its arguments into bytes using the standard ``write`` functions and returns the base64-encoded string.
Given a ``write``\ -like function ``writefunc``\ , which takes an I/O stream as its first argument, ``base64encode(writefunc, args...)`` calls ``writefunc`` to write ``args...`` to a base64-encoded string, and returns the string. ``base64encode(args...)`` is equivalent to ``base64encode(write, args...)``\ : it converts its arguments into bytes using the standard ``write`` functions and returns the base64-encoded string.

.. function:: base64decode(string)

Expand Down
Loading

0 comments on commit 3fcea09

Please sign in to comment.