Package: node-array-equal
Severity: wishlist

Dear Maintainer,

while translating this package's description I noticed that it isn't easily 
readable on the web because the two lines with assert()'s are reflown as per 
the Debian policy
https://packages.debian.org/en/sid/node-array-equal

You can either add another paragraph split "." between the two:

 This node module check whether two arrays are equal:
 .
 var equals = require('array-equal')
 .
 assert(equals([1, 2, 3], [1, 2, 3])) // => true
 .
 assert(equals([1, 2, 3], [1, 2, 3, 4])) // => false
 .
 Node.js is an event-based server-side JavaScript engine.

Or you can join all three lines in a single paragraph indented with a space so 
that it isn't reflown:
 This node module check whether two arrays are equal:
 . 
  var equals = require('array-equal')
  assert(equals([1, 2, 3], [1, 2, 3])) // => true   
  assert(equals([1, 2, 3], [1, 2, 3, 4])) // => false
 . 
 Node.js is an event-based server-side JavaScript engine.

Or you can do both things: three indented paragraphs.
In the current web site packages.debian.org, indented lines are rendered with a 
monospaced font which helps to set aside the code sample from the rest.

Separated paragraphs are easier to deal with when updating translations, but in 
this case the code sample will be copied verbatim so it doesn't make a big 
difference.

Note also that in the first line an "s" is missing, ie "This node module check" 
should read "This node module checks".

thanks,
Daniele

_______________________________________________
Pkg-javascript-devel mailing list
Pkg-javascript-devel@lists.alioth.debian.org
http://lists.alioth.debian.org/cgi-bin/mailman/listinfo/pkg-javascript-devel

Reply via email to