[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#664629: ITP: node-block-stream -- Stream of fixed-size blocks, with zero-padding when necessary



On 19/03/2012 15:33, martin f krafft wrote:
> also sprach Jérémy Lal <kapouer@melix.org> [2012.03.19.1510 +0100]:
>> * Package name    : node-block-stream
>>   Version         : 0.0.5
>>   Upstream Author : Isaac Z. Schlueter <i@izs.me>
>> * URL             : https://github.com/isaacs/block-stream
>> * License         : BSD-2-clause
>>   Programming Lang: JavaScript
>>   Description     : Stream of fixed-size blocks, with zero-padding when necessary
>>
>> Write data into it, and it'll output data in buffer blocks of given size,
>> padding with zeroes if necessary when .end() or .flush() are called.
> 
> This is a bad description, IMHO. You should not reference "it".
> 
> Also — and this goes for all node-* packages that are being packaged
> — please try to adopt a consistent approach to the description. The
> description should answer the most important questions, like "what
> is this?", "who needs this?" and maybe even "what is node?".

Thank you for your suggestion,
here's a better one for node-block-stream :

 node-block-stream is a Node.js module providing a stream-like object that
 reads or writes data as a stream of blocks.
 A typical use of node-block-stream is processing tar archives.
 .
 Node.js is an event-based server-side javascript engine.


I'll rewrite the other ones in recent node-* packages.

Jérémy.




Reply to: