Skip to content

Commit

Permalink
doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
amitmurthy committed Oct 18, 2016
1 parent d42c6b0 commit 2e854b4
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion base/channels.jl
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ fetch_unbuffered(c::Channel) = throw(ErrorException("`fetch` is not supported on
"""
take!(c::Channel)
Removes and returns a value from a `Channel`. Blocks till data is available.
Removes and returns a value from a `Channel`. Blocks until data is available.
For unbuffered channels, blocks until a `put!` is performed by a different
task.
Expand Down
6 changes: 3 additions & 3 deletions base/docs/helpdb/Base.jl
Original file line number Diff line number Diff line change
Expand Up @@ -1427,14 +1427,14 @@ endof
Channel{T}(sz::Int)
Constructs a `Channel` with an internal buffer that can hold a maximum of `sz` objects
of type `T`. `put!` calls on a full channel block till an object is removed with `take!`.
of type `T`. `put!` calls on a full channel block until an object is removed with `take!`.
`Channel(0)` constructs an unbuffered channel. `put!` blocks till a matching `take!` is called.
`Channel(0)` constructs an unbuffered channel. `put!` blocks until a matching `take!` is called.
And vice-versa.
Other constructors:
- `Channel(Inf)` - equivalent to `Channel{Any}(typemax(UInt))`
- `Channel(Inf)` - equivalent to `Channel{Any}(typemax(Int))`
- `Channel(sz)` equivalent to `Channel{Any}(sz)`
"""
Channel
Expand Down
8 changes: 4 additions & 4 deletions doc/stdlib/parallel.rst
Original file line number Diff line number Diff line change
Expand Up @@ -115,13 +115,13 @@ Tasks

.. Docstring generated from Julia source
Constructs a ``Channel`` with an internal buffer that can hold a maximum of ``sz`` objects of type ``T``\ . ``put!`` calls on a full channel block till an object is removed with ``take!``\ .
Constructs a ``Channel`` with an internal buffer that can hold a maximum of ``sz`` objects of type ``T``\ . ``put!`` calls on a full channel block until an object is removed with ``take!``\ .

``Channel(0)`` constructs an unbuffered channel. ``put!`` blocks till a matching ``take!`` is called. And vice-versa.
``Channel(0)`` constructs an unbuffered channel. ``put!`` blocks until a matching ``take!`` is called. And vice-versa.

Other constructors:

* ``Channel(Inf)`` - equivalent to ``Channel{Any}(typemax(UInt))``
* ``Channel(Inf)`` - equivalent to ``Channel{Any}(typemax(Int))``
* ``Channel(sz)`` equivalent to ``Channel{Any}(sz)``

.. function:: put!(c::Channel, v)
Expand All @@ -136,7 +136,7 @@ Tasks

.. Docstring generated from Julia source
Removes and returns a value from a ``Channel``\ . Blocks till data is available.
Removes and returns a value from a ``Channel``\ . Blocks until data is available.

For unbuffered channels, blocks until a ``put!`` is performed by a different task.

Expand Down

0 comments on commit 2e854b4

Please sign in to comment.