Re: Explicitly document return values in some core.async functions?
core.async is still technically alpha, so everything is potentially subject to change. Rich H. wrote[1] most of those core.async functions, and he tends to treat the docstring as the only contract for future releases. If you want to be safe, make a unit test in your app that specifically tests any undocumented properties of public functions, so you can see if and when they change. [1]: https://github.com/clojure/core.async/blame/d8047c0b0ec13788c1092f579f03733ee635c493/src/main/clojure/clojure/core/async.clj#L455 –S On Wednesday, April 22, 2015 at 11:26:11 AM UTC+1, Stanislav Yurin wrote: Hello, There are functions like 'pipe' and 'tap' that are returning back receiving channel parameter, but this behavior is not explicitly documented. Should we rely on this feature or this may be changed in future? Thanks. Stanislav. -- You received this message because you are subscribed to the Google Groups Clojure group. To post to this group, send email to clojure@googlegroups.com Note that posts from new members are moderated - please be patient with your first post. To unsubscribe from this group, send email to clojure+unsubscr...@googlegroups.com For more options, visit this group at http://groups.google.com/group/clojure?hl=en --- You received this message because you are subscribed to the Google Groups Clojure group. To unsubscribe from this group and stop receiving emails from it, send an email to clojure+unsubscr...@googlegroups.com. For more options, visit https://groups.google.com/d/optout.
Re: Explicitly document return values in some core.async functions?
Thanks, this is perfectly reasonable! On Wednesday, April 22, 2015 at 4:35:17 PM UTC+3, Stuart Sierra wrote: core.async is still technically alpha, so everything is potentially subject to change. Rich H. wrote[1] most of those core.async functions, and he tends to treat the docstring as the only contract for future releases. If you want to be safe, make a unit test in your app that specifically tests any undocumented properties of public functions, so you can see if and when they change. [1]: https://github.com/clojure/core.async/blame/d8047c0b0ec13788c1092f579f03733ee635c493/src/main/clojure/clojure/core/async.clj#L455 –S On Wednesday, April 22, 2015 at 11:26:11 AM UTC+1, Stanislav Yurin wrote: Hello, There are functions like 'pipe' and 'tap' that are returning back receiving channel parameter, but this behavior is not explicitly documented. Should we rely on this feature or this may be changed in future? Thanks. Stanislav. -- You received this message because you are subscribed to the Google Groups Clojure group. To post to this group, send email to clojure@googlegroups.com Note that posts from new members are moderated - please be patient with your first post. To unsubscribe from this group, send email to clojure+unsubscr...@googlegroups.com For more options, visit this group at http://groups.google.com/group/clojure?hl=en --- You received this message because you are subscribed to the Google Groups Clojure group. To unsubscribe from this group and stop receiving emails from it, send an email to clojure+unsubscr...@googlegroups.com. For more options, visit https://groups.google.com/d/optout.
Explicitly document return values in some core.async functions?
Hello, There are functions like 'pipe' and 'tap' that are returning back receiving channel parameter, but this behavior is not explicitly documented. Should we rely on this feature or this may be changed in future? Thanks. Stanislav. -- You received this message because you are subscribed to the Google Groups Clojure group. To post to this group, send email to clojure@googlegroups.com Note that posts from new members are moderated - please be patient with your first post. To unsubscribe from this group, send email to clojure+unsubscr...@googlegroups.com For more options, visit this group at http://groups.google.com/group/clojure?hl=en --- You received this message because you are subscribed to the Google Groups Clojure group. To unsubscribe from this group and stop receiving emails from it, send an email to clojure+unsubscr...@googlegroups.com. For more options, visit https://groups.google.com/d/optout.
