Skip to content

Commit

Permalink
formatting fixes and update helpdb
Browse files Browse the repository at this point in the history
  • Loading branch information
JeffBezanson committed Aug 31, 2013
1 parent 2839262 commit 0a2266c
Show file tree
Hide file tree
Showing 7 changed files with 172 additions and 26 deletions.
2 changes: 2 additions & 0 deletions base/deprecated.jl
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,8 @@ function ls(args...)
warn_once("ls() is deprecated, use readdir() instead. If you are at the repl prompt, consider `;ls`.")
deprecated_ls(args...)
end
export ls

function start_timer(timer::Timer, timeout::Int, repeat::Int)
warn_once("start_timer now expects arguments in units of seconds. you may need to update your code")
invoke(start_timer, (Timer,Real,Real), timer, timeout, repeat)
Expand Down
1 change: 0 additions & 1 deletion base/exports.jl
Original file line number Diff line number Diff line change
Expand Up @@ -1162,7 +1162,6 @@ export
issocket,
issticky,
iswritable,
ls,
lstat,
mkdir,
mkpath,
Expand Down
4 changes: 0 additions & 4 deletions doc/UNDOCUMENTED.rst
Original file line number Diff line number Diff line change
Expand Up @@ -93,10 +93,6 @@ linear algebra

UNDOCUMENTED

.. function:: symmetrize!(...)

UNDOCUMENTED


sparse
------
Expand Down
179 changes: 164 additions & 15 deletions doc/helpdb.jl
Original file line number Diff line number Diff line change
Expand Up @@ -37,16 +37,30 @@
("Getting Around","Base","edit","edit(file::String[, line])
Edit a file optionally providing a line number to edit at. Returns
to the julia prompt when you quit the editor. If the file name ends
in \".jl\" it is reloaded when the editor closes the file.
to the julia prompt when you quit the editor.
"),

("Getting Around","Base","edit","edit(function[, types])
Edit the definition of a function, optionally specifying a tuple of
types to indicate which method to edit. When the editor exits, the
source file containing the definition is reloaded.
types to indicate which method to edit.
"),

("Getting Around","Base","less","less(file::String[, line])
Show a file using the default pager, optionally providing a
starting line number. Returns to the julia prompt when you quit the
pager.
"),

("Getting Around","Base","less","less(function[, types])
Show the definition of a function using the default pager,
optionally specifying a tuple of types to indicate which method to
see.
"),

Expand Down Expand Up @@ -634,9 +648,11 @@
"),

("Iterable Collections","Base","contains","contains(itr, x) -> Bool
("Iterable Collections","Base","in","in(item, collection) -> Bool
Determine whether a collection contains the given value, \"x\".
Determine whether an item is in the given collection, in the sense
that it is \"isequal\" to one of the values generated by iterating
over the collection.
"),

Expand Down Expand Up @@ -1207,13 +1223,6 @@
"),

("Strings","Base","is_utf8_start","is_utf8_start(byte) -> Bool
Determine whether a byte can start a valid UTF-8 character
sequence.
"),

("Strings","Base","is_valid_char","is_valid_char(c) -> Bool
Returns true if the given char or integer is a valid Unicode code
Expand Down Expand Up @@ -1269,6 +1278,40 @@

("Strings","Base","search","search(string, chars[, start])
Search for the first occurance of the given characters within the
given string. The second argument may be a single character, a
vector or a set of characters, a string, or a regular expression
(though regular expressions are only allowed on contiguous strings,
such as ASCII or UTF-8 strings). The third argument optionally
specifies a starting index. The return value is a range of indexes
where the matching sequence is found, such that \"s[search(s,x)] ==
x\". The return value is \"0:-1\" if there is no match.
"),

("Strings","Base","rsearch","rsearch(string, chars[, start])
Similar to \"search\", but returning the last occurance of the
given characters within the given string, searching in reverse from
>>``<<start.''.
"),

("Strings","Base","index","index(string, chars[, start])
Similar to \"search\", but return only the start index at which the
characters were found, or 0 if they were not.
"),

("Strings","Base","rindex","rindex(string, chars[, start])
Similar to \"rsearch\", but return only the start index at which
the characters were found, or 0 if they were not.
Similar to \"search\", but return only the start index at which
the characters were found, or 0 if they were not.
Search for the given characters within the given string. The second
argument may be a single character, a vector or a set of
characters, a string, or a regular expression (though regular
Expand All @@ -1287,6 +1330,12 @@
"),

("Strings","Base","contains","contains(haystack, needle)
Determine whether the second argument is a substring of the first.
"),

("Strings","Base","replace","replace(string, pat, r[, n])
Search for the given pattern \"pat\", and replace each occurrence
Expand Down Expand Up @@ -4265,6 +4314,12 @@ popdisplay(d::Display)
"),

("Numbers","Base","catalan","catalan
Catalan's constant
"),

("Numbers","Base","Inf","Inf
Positive infinity of type Float64
Expand Down Expand Up @@ -4875,6 +4930,13 @@ popdisplay(d::Display)
"),

("Arrays","Base","slice","slice(A, inds...)
Create a view of the given indexes of array \"A\", dropping
dimensions indexed with scalars.
"),

("Arrays","Base","setindex!","setindex!(A, X, inds...)
Store values from array \"X\" within some subset of \"A\" as
Expand Down Expand Up @@ -4970,6 +5032,14 @@ popdisplay(d::Display)
"),

("Arrays","Base","findnz","findnz(A)
Return a tuple \"(I, J, V)\" where \"I\" and \"J\" are the row and
column indexes of the non-zero values in matrix \"A\", and \"V\" is
a vector of the non-zero values.
"),

("Arrays","Base","nonzeros","nonzeros(A)
Return a vector of the non-zero values in array \"A\".
Expand Down Expand Up @@ -5044,6 +5114,21 @@ popdisplay(d::Display)
"),

("Arrays","Base","promote_shape","promote_shape(s1, s2)
Check two array shapes for compatibility, allowing trailing
singleton dimensions, and return whichever shape has more
dimensions.
"),

("Arrays","Base","checkbounds","checkbounds(array, indexes...)
Throw an error if the specified indexes are not in bounds for the
given array.
"),

("Arrays","Base","cumprod","cumprod(A[, dim])
Cumulative product along a dimension.
Expand Down Expand Up @@ -5338,9 +5423,17 @@ popdisplay(d::Display)
"),

("Statistics","Base","median","median(v)
("Statistics","Base","median","median(v; checknan::Bool=true)
Compute the median of a vector \"v\".
Compute the median of a vector \"v\". If keyword argument
\"checknan\" is true (the default), an error is raised for data
containing NaN values.
"),

("Statistics","Base","median!","median!(v; checknan::Bool=true)
Like \"median\", but may overwrite the input vector.
"),

Expand All @@ -5362,6 +5455,18 @@ popdisplay(d::Display)
"),

("Statistics","Base","hist2d","hist2d(M, e1, e2) -> (edge1, edge2, counts)
Compute a \"2d histogram\" of a set of N points specified by N-by-2
matrix \"M\". Arguments \"e1\" and \"e2\" are bins for each
dimension, specified either as integer bin counts or vectors of bin
edges. The result is a tuple of \"edge1\" (the bin edges used in
the first dimension), \"edge2\" (the bin edges used in the second
dimension), and \"counts\", a histogram matrix of size
\"(length(edge1)-1, length(edge2)-1)\".
"),

("Statistics","Base","histrange","histrange(v, n)
Compute *nice* bin ranges for the edges of a histogram of \"v\",
Expand Down Expand Up @@ -5391,6 +5496,12 @@ popdisplay(d::Display)
"),

("Statistics","Base","quantile!","quantile!(v[, p])
Like \"quantile\", but overwrites the input vector.
"),

("Statistics","Base","cov","cov(v1[, v2])
Compute the Pearson covariance between two vectors \"v1\" and
Expand Down Expand Up @@ -7155,6 +7266,13 @@ popdisplay(d::Display)
"),

("Reflection","Base","functionlocs","functionlocs(f::Function, types)
Returns an array of the results of \"functionloc\" for all matching
definitions.
"),

("Internals","Base","gc","gc()
Perform garbage collection. This should not generally be used.
Expand Down Expand Up @@ -7481,6 +7599,29 @@ popdisplay(d::Display)
"),

("Filesystem","Base","splitdir","splitdir(path::String) -> (String, String)
Split a path into a tuple of the directory name and file name.
"),

("Filesystem","Base","splitdrive","splitdrive(path::String) -> (String, String)
On Windows, split a path into the drive letter part and the path
part. On Unix systems, the first component is always the empty
string.
"),

("Filesystem","Base","splitext","splitext(path::String) -> (String, String)
If the last component of a path contains a dot, split the path into
everything before the dot and everything including and after the
dot. Otherwise, return a tuple of the argument unmodified and the
empty string.
"),

("Filesystem","Base","tempname","tempname()
Generate a unique temporary filename.
Expand Down Expand Up @@ -8150,6 +8291,14 @@ popdisplay(d::Display)
"),

("Linear Algebra","Base","symmetrize!","symmetrize!(A[, UL::Char])
\"symmetrize!(A)\" converts from the BLAS/LAPACK symmetric storage
format, in which only the \"UL\" ('U'pper or 'L'ower, default 'U')
triangle is used, to a full symmetric matrix.
"),

("Linear Algebra","Base","Tridiagonal","Tridiagonal(dl, d, du)
Construct a tridiagonal matrix from the lower diagonal, diagonal,
Expand Down
2 changes: 1 addition & 1 deletion doc/stdlib/base.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2903,7 +2903,7 @@ Numbers

The constant e

:: data:: catalan
.. data:: catalan

Catalan's constant

Expand Down
4 changes: 2 additions & 2 deletions doc/stdlib/linalg.rst
Original file line number Diff line number Diff line change
Expand Up @@ -259,10 +259,10 @@ Linear algebra functions in Julia are largely implemented by calling functions f

``scale!(A,B)`` overwrites the input array with the scaled result.

.. function:: symmetrize!(A[, UL])
.. function:: symmetrize!(A[, UL::Char])

``symmetrize!(A)`` converts from the BLAS/LAPACK symmetric storage
format, in which only the ``UL`` ("U"pper or "L"ower, default "U")
format, in which only the ``UL`` ('U'pper or 'L'ower, default 'U')
triangle is used, to a full symmetric matrix.

.. function:: Tridiagonal(dl, d, du)
Expand Down
6 changes: 3 additions & 3 deletions src/ccall.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,12 @@ extern "C" DLLEXPORT void jl_read_sonames()
int j = i;
while (!isspace(dot[++j])) ;
char *arch = strstr(dot+i,"x86-64");
if (arch != NULL && arch < dot + j)
{
if (arch != NULL && arch < dot + j) {
#ifdef _P32
continue;
#endif
} else {
}
else {
#ifdef _P64
continue;
#endif
Expand Down

0 comments on commit 0a2266c

Please sign in to comment.