Document await that it will never return if shutdown-agents was called

Description

Undocumented behavior or the "await" function: it will never return if shutdown-agents was called.

This was a surprise to me to find yet another condition when await never returns.

Proposal: Change the docstring for clojure.core/await from "...Will never return if a failed agent is restarted with :clear-actions true." to
"...Will never return if a failed agent is restarted with :clear-actions true or shutdown-agents was called."

Patch: CLJ-1918.patch

Prescreened by: Alex Miller

Environment

None

Attachments

1

Activity

Show:
Completed

Details

Assignee

Reporter

Approval

Patch

Priority

Affects versions

Fix versions

Created April 25, 2016 at 2:43 PM
Updated September 7, 2017 at 8:46 PM
Resolved September 7, 2017 at 8:46 PM