<< Back to previous view

[ASYNC-167] Fix docstring for put! and friends Created: 27/Apr/16  Updated: 27/Apr/16

Status: Open
Project: core.async
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Enhancement Priority: Minor
Reporter: Alan Thompson Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: docstring, documentation


The docstring for `put!` and friends is misleading and incorrect. They repeatedly mention "port" where the user knows only the term "channel".

Also, description of `fn0` is missing & incorrect. The phrase "Will throw if closed" is incorrect. fn0 is called with a single arg, which is `true` upon success and `false` if the channel is closed.

Generated at Thu Apr 28 15:00:24 CDT 2016 using JIRA 4.4#649-r158309.