Skip to content

Commit

Permalink
regenerate the manual
Browse files Browse the repository at this point in the history
  • Loading branch information
MikeInnes committed Jun 28, 2015
1 parent da8cd21 commit a6427bc
Show file tree
Hide file tree
Showing 8 changed files with 340 additions and 71 deletions.
4 changes: 3 additions & 1 deletion doc/stdlib/arrays.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,9 @@ Basic functions

.. function:: eachindex(A...)

Creates an iterable object for visiting each index of an AbstractArray "A" in an efficient manner. For array types that have opted into fast linear indexing (like "Array"), this is simply the range "1:length(A)". For other array types, this returns a specialized Cartesian range to efficiently index into the array with indices specified for every dimension. Example for a sparse 2-d array:
Creates an iterable object for visiting each index of an AbstractArray "A" in an efficient manner. For array types that have opted into fast linear indexing (like "Array"), this is simply the range "1:length(A)". For other array types, this returns a specialized Cartesian range to efficiently index into the array with indices specified for every dimension. For other iterables, including strings and dictionaries, this returns an iterator object supporting arbitrary index types (e.g. unevenly spaced or non-integer indices).

Example for a sparse 2-d array:

::

Expand Down
32 changes: 28 additions & 4 deletions doc/stdlib/base.rst
Original file line number Diff line number Diff line change
Expand Up @@ -835,10 +835,22 @@ System

Alternate syntax for open, where a string-based mode specifier is used instead of the five booleans. The values of "mode" correspond to those from "fopen(3)" or Perl "open", and are equivalent to setting the following boolean groups:

+–––+–––––––––––––––––-+ | r | read | +–––+–––––––––––––––––-+ | r+ | read, write | +–––+–––––––––––––––––-+ | w | write, create, truncate | +–––+–––––––––––––––––-+ | w+ | read, write, create, truncate | +–––+–––––––––––––––––-+ | a | write, create, append | +–––+–––––––––––––––––-+ | a+ | read, write, create, append | +–––+–––––––––––––––––-+

::

+------+-----------------------------------+
| r | read |
+------+-----------------------------------+
| r+ | read, write |
+------+-----------------------------------+
| w | write, create, truncate |
+------+-----------------------------------+
| w+ | read, write, create, truncate |
+------+-----------------------------------+
| a | write, create, append |
+------+-----------------------------------+
| a+ | read, write, create, append |
+------+-----------------------------------+

open(f::function, args...)

Apply the function "f" to the result of "open(args...)" and close the resulting file descriptor upon completion.
Expand Down Expand Up @@ -868,10 +880,22 @@ System

Alternate syntax for open, where a string-based mode specifier is used instead of the five booleans. The values of "mode" correspond to those from "fopen(3)" or Perl "open", and are equivalent to setting the following boolean groups:

+–––+–––––––––––––––––-+ | r | read | +–––+–––––––––––––––––-+ | r+ | read, write | +–––+–––––––––––––––––-+ | w | write, create, truncate | +–––+–––––––––––––––––-+ | w+ | read, write, create, truncate | +–––+–––––––––––––––––-+ | a | write, create, append | +–––+–––––––––––––––––-+ | a+ | read, write, create, append | +–––+–––––––––––––––––-+

::

+------+-----------------------------------+
| r | read |
+------+-----------------------------------+
| r+ | read, write |
+------+-----------------------------------+
| w | write, create, truncate |
+------+-----------------------------------+
| w+ | read, write, create, truncate |
+------+-----------------------------------+
| a | write, create, append |
+------+-----------------------------------+
| a+ | read, write, create, append |
+------+-----------------------------------+

open(f::function, args...)

Apply the function "f" to the result of "open(args...)" and close the resulting file descriptor upon completion.
Expand Down
15 changes: 10 additions & 5 deletions doc/stdlib/collections.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1160,7 +1160,7 @@ Given a dictionary ``D``, the syntax ``D[x]`` returns the value of key ``x`` (if

.. function:: merge(collection, others...)

Construct a merged collection from the given collections. If necessary, the types of the resulting collection will be promoted to accommodate the types of the merged collections.
Construct a merged collection from the given collections. If necessary, the types of the resulting collection will be promoted to accommodate the types of the merged collections. If the same key is present in another collection, the value for that key will be the value it has in the last collection listed.

::

Expand All @@ -1169,14 +1169,19 @@ Given a dictionary ``D``, the syntax ``D[x]`` returns the value of key ``x`` (if
"bar" => 42.0
"foo" => 0.0

julia> b = Dict(utf8("baz") => 17, utf8("qux") => 4711)
julia> b = Dict(utf8("baz") => 17, utf8("bar") => 4711)
Dict{UTF8String,Int64} with 2 entries:
"bar" => 4711
"baz" => 17
"qux" => 4711

julia> merge(a, b)
Dict{UTF8String,Float64} with 4 entries:
"qux" => 4711.0
Dict{UTF8String,Float64} with 3 entries:
"bar" => 4711.0
"baz" => 17.0
"foo" => 0.0

julia> merge(b, a)
Dict{UTF8String,Float64} with 3 entries:
"bar" => 42.0
"baz" => 17.0
"foo" => 0.0
Expand Down
180 changes: 174 additions & 6 deletions doc/stdlib/dates.rst

Large diffs are not rendered by default.

38 changes: 36 additions & 2 deletions doc/stdlib/file.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,33 @@

Returns a structure whose fields contain information about the file. The fields of the structure are:

+–––––-+––––––––––––––––––––––––––––––––––––+ | size | The size (in bytes) of the file | +–––––-+––––––––––––––––––––––––––––––––––––+ | device | ID of the device that contains the file | +–––––-+––––––––––––––––––––––––––––––––––––+ | inode | The inode number of the file | +–––––-+––––––––––––––––––––––––––––––––––––+ | mode | The protection mode of the file | +–––––-+––––––––––––––––––––––––––––––––––––+ | nlink | The number of hard links to the file | +–––––-+––––––––––––––––––––––––––––––––––––+ | uid | The user id of the owner of the file | +–––––-+––––––––––––––––––––––––––––––––––––+ | gid | The group id of the file owner | +–––––-+––––––––––––––––––––––––––––––––––––+ | rdev | If this file refers to a device, the ID of the device it refers to | +–––––-+––––––––––––––––––––––––––––––––––––+ | blksize | The file-system preferred block size for the file | +–––––-+––––––––––––––––––––––––––––––––––––+ | blocks | The number of such blocks allocated | +–––––-+––––––––––––––––––––––––––––––––––––+ | mtime | Unix timestamp of when the file was last modified | +–––––-+––––––––––––––––––––––––––––––––––––+ | ctime | Unix timestamp of when the file was created | +–––––-+––––––––––––––––––––––––––––––––––––+
::

+-----------+------------------------------------------------------------------------+
| size | The size (in bytes) of the file |
+-----------+------------------------------------------------------------------------+
| device | ID of the device that contains the file |
+-----------+------------------------------------------------------------------------+
| inode | The inode number of the file |
+-----------+------------------------------------------------------------------------+
| mode | The protection mode of the file |
+-----------+------------------------------------------------------------------------+
| nlink | The number of hard links to the file |
+-----------+------------------------------------------------------------------------+
| uid | The user id of the owner of the file |
+-----------+------------------------------------------------------------------------+
| gid | The group id of the file owner |
+-----------+------------------------------------------------------------------------+
| rdev | If this file refers to a device, the ID of the device it refers to |
+-----------+------------------------------------------------------------------------+
| blksize | The file-system preferred block size for the file |
+-----------+------------------------------------------------------------------------+
| blocks | The number of such blocks allocated |
+-----------+------------------------------------------------------------------------+
| mtime | Unix timestamp of when the file was last modified |
+-----------+------------------------------------------------------------------------+
| ctime | Unix timestamp of when the file was created |
+-----------+------------------------------------------------------------------------+


.. function:: lstat(file)
Expand Down Expand Up @@ -100,7 +126,15 @@

Gets the permissions of the owner of the file as a bitfield of

+–––+–––––––––––-+ | 01 | Execute Permission | +–––+–––––––––––-+ | 02 | Write Permission | +–––+–––––––––––-+ | 04 | Read Permission | +–––+–––––––––––-+
::

+------+-----------------------+
| 01 | Execute Permission |
+------+-----------------------+
| 02 | Write Permission |
+------+-----------------------+
| 04 | Read Permission |
+------+-----------------------+

For allowed arguments, see "stat".

Expand Down
48 changes: 42 additions & 6 deletions doc/stdlib/io-network.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,22 @@ General I/O

Alternate syntax for open, where a string-based mode specifier is used instead of the five booleans. The values of "mode" correspond to those from "fopen(3)" or Perl "open", and are equivalent to setting the following boolean groups:

+–––+–––––––––––––––––-+ | r | read | +–––+–––––––––––––––––-+ | r+ | read, write | +–––+–––––––––––––––––-+ | w | write, create, truncate | +–––+–––––––––––––––––-+ | w+ | read, write, create, truncate | +–––+–––––––––––––––––-+ | a | write, create, append | +–––+–––––––––––––––––-+ | a+ | read, write, create, append | +–––+–––––––––––––––––-+

::

+------+-----------------------------------+
| r | read |
+------+-----------------------------------+
| r+ | read, write |
+------+-----------------------------------+
| w | write, create, truncate |
+------+-----------------------------------+
| w+ | read, write, create, truncate |
+------+-----------------------------------+
| a | write, create, append |
+------+-----------------------------------+
| a+ | read, write, create, append |
+------+-----------------------------------+

open(f::function, args...)

Apply the function "f" to the result of "open(args...)" and close the resulting file descriptor upon completion.
Expand Down Expand Up @@ -74,10 +86,22 @@ General I/O

Alternate syntax for open, where a string-based mode specifier is used instead of the five booleans. The values of "mode" correspond to those from "fopen(3)" or Perl "open", and are equivalent to setting the following boolean groups:

+–––+–––––––––––––––––-+ | r | read | +–––+–––––––––––––––––-+ | r+ | read, write | +–––+–––––––––––––––––-+ | w | write, create, truncate | +–––+–––––––––––––––––-+ | w+ | read, write, create, truncate | +–––+–––––––––––––––––-+ | a | write, create, append | +–––+–––––––––––––––––-+ | a+ | read, write, create, append | +–––+–––––––––––––––––-+

::

+------+-----------------------------------+
| r | read |
+------+-----------------------------------+
| r+ | read, write |
+------+-----------------------------------+
| w | write, create, truncate |
+------+-----------------------------------+
| w+ | read, write, create, truncate |
+------+-----------------------------------+
| a | write, create, append |
+------+-----------------------------------+
| a+ | read, write, create, append |
+------+-----------------------------------+

open(f::function, args...)

Apply the function "f" to the result of "open(args...)" and close the resulting file descriptor upon completion.
Expand Down Expand Up @@ -107,10 +131,22 @@ General I/O

Alternate syntax for open, where a string-based mode specifier is used instead of the five booleans. The values of "mode" correspond to those from "fopen(3)" or Perl "open", and are equivalent to setting the following boolean groups:

+–––+–––––––––––––––––-+ | r | read | +–––+–––––––––––––––––-+ | r+ | read, write | +–––+–––––––––––––––––-+ | w | write, create, truncate | +–––+–––––––––––––––––-+ | w+ | read, write, create, truncate | +–––+–––––––––––––––––-+ | a | write, create, append | +–––+–––––––––––––––––-+ | a+ | read, write, create, append | +–––+–––––––––––––––––-+

::

+------+-----------------------------------+
| r | read |
+------+-----------------------------------+
| r+ | read, write |
+------+-----------------------------------+
| w | write, create, truncate |
+------+-----------------------------------+
| w+ | read, write, create, truncate |
+------+-----------------------------------+
| a | write, create, append |
+------+-----------------------------------+
| a+ | read, write, create, append |
+------+-----------------------------------+

open(f::function, args...)

Apply the function "f" to the result of "open(args...)" and close the resulting file descriptor upon completion.
Expand Down
Loading

0 comments on commit a6427bc

Please sign in to comment.