node-addon-api icon indicating copy to clipboard operation
node-addon-api copied to clipboard

Discussion: Formatting inconsistency in markdown documentation

Open KevinEady opened this issue 1 year ago • 3 comments

Some documented methods have the C++ definition before the description:

https://github.com/nodejs/node-addon-api/blob/b8525e2f8ca8887c5ec864706c27b8872a5a6256/doc/env.md?plain=1#L87-L104

... while others have the description before the C++ definition:

https://github.com/nodejs/node-addon-api/blob/b8525e2f8ca8887c5ec864706c27b8872a5a6256/doc/addon.md?plain=1#L144-L161

For some rough stats, it seems to be split almost evenly... Searching for ### .+\n+``` (ie. definition first) gives 208 results, while ### .+\n+\w (ie. description first) gives 219 results.

Do we have a preference? Does it matter?

KevinEady avatar Jul 04 '24 10:07 KevinEady