core.async

Clarify timeout doc to mention that close! should not be called on a timeout channel

Details

  • Type: Defect Defect
  • Status: Open Open
  • Priority: Major Major
  • Resolution: Unresolved
  • Affects Version/s: None
  • Fix Version/s: None
  • Component/s: None
  • Patch:
    Code

Description

After running into a race-condition involving closed timeout channels, it seems like it would be appropriate to mention that `close!` should never be called on a timeout channel in its docstring. The attached patch tweaks the doc string to that effect. Please advise if you'd like the wording changed a bit.

Activity

Hide
Howard Lewis Ship added a comment -

Alternately/additionally, it would be nice if close! on a timeout channel would throw an exception.

Show
Howard Lewis Ship added a comment - Alternately/additionally, it would be nice if close! on a timeout channel would throw an exception.
Hide
Erik Assum added a comment -

or alternately, make it a no-op?

Show
Erik Assum added a comment - or alternately, make it a no-op?
Alex Miller made changes -
Field Original Value New Value
Labels documentation docstring documentation

People

Vote (4)
Watch (2)

Dates

  • Created:
    Updated: