pipeline-async docstring correction

Description

Currently says:

"af must close! the channel before returning."

more correctly:

"af is responsible for closing the channel.", or similar.

af is asynchronous so should return immediately, the thread or go-block it spawns should close the channel later.

Environment

None

Activity

Show:

Alex Miller November 23, 2021 at 4:29 PM

Released in 1.5.640

Alex Miller November 17, 2021 at 8:28 PM

Updated for next release

David Bürgin September 19, 2017 at 6:21 PM

( There may be a word missing in the first clause of your comment?)

I cast my vote for this a while ago, but would prefer an even more explicit wording along the lines (native speaker input welcome):

"af must arrange for the channel to be closed eventually before returning."

Seems like an easy fix for a moderately upvoted issue, would you accept a patch for this? (If yes, is the policy to reflow the rest of the paragraph?)

Pierre-Yves Ritschard August 28, 2017 at 2:13 PM

I tend to find the suggested wording, I ended here while wanting to make sure I had understood the intent of the initial docstring correctly.

Fixed

Details

Assignee

Reporter

Priority

Created August 27, 2015 at 1:14 PM
Updated November 23, 2021 at 4:29 PM
Resolved November 17, 2021 at 8:28 PM

Flag notifications