Skip to content

adds some details to at-async and tweaks at-schedule doc #13218

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 16, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions base/docs/helpdb.jl
Original file line number Diff line number Diff line change
Expand Up @@ -2384,7 +2384,7 @@ promote
doc"""
@schedule

Wrap an expression in a `Task` and add it to the scheduler's queue.
Wrap an expression in a `Task` and add it to the local machine's scheduler queue.
"""
:@schedule

Expand Down Expand Up @@ -4672,7 +4672,7 @@ erfinv
doc"""
@async

Wraps an expression in a closure and schedules it to run on the local machine. Also adds it to the set of items that the nearest enclosing `@sync` waits for.
Like `@schedule`, `@async` wraps an expression in a `Task` and adds it to the local machine's scheduler queue. Additionally it adds the task to the set of items that the nearest enclosing `@sync` waits for. `@async` also wraps the expression in a `let x=x, y=y, ...` block to create a new scope with copies of all variables referenced in the expression.
"""
:@async

Expand Down
4 changes: 2 additions & 2 deletions doc/stdlib/parallel.rst
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ Tasks

.. Docstring generated from Julia source

Wrap an expression in a ``Task`` and add it to the scheduler's queue.
Wrap an expression in a ``Task`` and add it to the local machine's scheduler queue.

.. function:: @task

Expand Down Expand Up @@ -401,7 +401,7 @@ General Parallel Computing Support

.. Docstring generated from Julia source

Wraps an expression in a closure and schedules it to run on the local machine. Also adds it to the set of items that the nearest enclosing ``@sync`` waits for.
Like ``@schedule``\ , ``@async`` wraps an expression in a ``Task`` and adds it to the local machine's scheduler queue. Additionally it adds the task to the set of items that the nearest enclosing ``@sync`` waits for. ``@async`` also wraps the expression in a ``let x=x, y=y, ...`` block to create a new scope with copies of all variables referenced in the expression.

.. function:: @sync

Expand Down