Docstring for deliver doesn't match behavior

Description

The docstring for deliver doesn't match the actual behavior. It says an exception gets thrown on multiple delivers, but that's no longer the case, as of 1.3 (hat tip to clgv on irc).

user=> (doc deliver)
-------------------------
clojure.core/deliver
([promise val])
  Alpha - subject to change.
  Delivers the supplied value to the promise, releasing any pending
  derefs. A subsequent call to deliver on a promise will throw an exception.
nil

(let [p (promise)] 
  (deliver p "hi") 
  (deliver p "bye") 
  @p)
;=> "hi"

This patch updates the docstring to reflect actual behavior: "will throw an exception." -> "will have no effect."

Environment

None

Attachments

correct-deliver-docstring.patch

10 Aug, 2012

0001-Update-docstring-for-deliver-s-actual-behavior.patch

07 Aug, 2012

Activity

Stuart Sierra

August 24, 2012 at 1:41 PM

https://clojure.atlassian.net/browse/CLJ-1038#icft=CLJ-1038 Update docstring for deliver's actual behavior (patch applied Aug 15, 2012)

Rich Hickey

August 10, 2012 at 9:09 PM

Don't doc return

Stuart Halloway

August 10, 2012 at 7:48 PM

Both patches are correct. Colin's patch documents the side effect, my variant also commits to the return values. Take your pick.

Resize work item view side panel

Completed

Details

Assignee

Colin Jones

Reporter

Colin Jones

Labels

documentation

Approval

Patch

Code

Priority

Minor

Affects versions

Release 1.4

Release 1.3

Created August 7, 2012 at 10:47 PM

Updated March 1, 2013 at 6:47 PM

Resolved March 1, 2013 at 6:47 PM