[Pkg-javascript-devel] add-node-component new option

Jonas Smedegaard jonas at jones.dk
Tue Feb 8 16:58:13 GMT 2022


Quoting Yadd (2022-02-08 17:46:13)
> I'm not fluent in English, please help me to fix this proposed 
> description:

Looks good to me!

Regarding syntax, however, I have a few comments:

 * I would use only single-level bullet points, and align with that 
   one-level indentation - i.e. no 2nd level and no 
   alignment-with-inline-colon

 * I would avoid backticks - generally I strip those, or (rarely) I 
   replace with double-quote.

Both of the above are to most reliably render with the various package 
description renderers: a long description is *not* Markdown - very few 
markup hints are defined, single-bullet indentation being the only one I 
am aware of.


 - Jonas

-- 
 * Jonas Smedegaard - idealist & Internet-arkitekt
 * Tlf.: +45 40843136  Website: http://dr.jones.dk/

 [x] quote me freely  [ ] ask before reusing  [ ] keep private
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 833 bytes
Desc: signature
URL: <http://alioth-lists.debian.net/pipermail/pkg-javascript-devel/attachments/20220208/bf38a13b/attachment.sig>


More information about the Pkg-javascript-devel mailing list