From d95efceee1ed363dc7152c82ddcfaa8e0f46ff9f Mon Sep 17 00:00:00 2001 From: Fabien Fleutot Date: Wed, 31 Jul 2013 16:00:35 +0200 Subject: [PATCH] documentation for improved ltn12.pump.all, ltn12.sink.chain, ltn12.source.chain --- doc/ltn12.html | 26 +++++++++++++++++++------- 1 file changed, 19 insertions(+), 7 deletions(-) diff --git a/doc/ltn12.html b/doc/ltn12.html index 54e66fb..94122dc 100644 --- a/doc/ltn12.html +++ b/doc/ltn12.html @@ -138,11 +138,16 @@ end

-ltn12.pump.all(source, sink) + ltn12.pump.all(source, + [filter1, filter2, ... filterN,] + sink)

-Pumps all data from a source to a sink. +Pumps all data from a source to a sink. If +additional filter +parameter filter1 ... filterN are +provided, they are inserted between the source and the sink.

@@ -174,11 +179,16 @@ of error, the function returns a false value, followed by an err

-ltn12.sink.chain(filter, sink) + ltn12.sink.chain(filter1[, + filter2 , ... filterN], + sink + )

-Creates and returns a new sink that passes data through a filter before sending it to a given sink. +Creates and returns a new sink that passes data through +filter1 ... filterN before sending it to +a given sink.

@@ -313,12 +323,14 @@ The function returns the new source.

-ltn12.source.chain(source, filter) + ltn12.source.chain(source, filter1[, + filter2 , ... filterN])

-Creates a new source that passes data through a filter -before returning it. + Creates a new source that passes data through + filter1 ... filterN + before returning it.