should we use inline doc / esdoc ?

PrismarineJS / prismarine-contribute

What is PrismarineJS and how to contribute

15 stars 3 forks source link

Open rom1504 opened 1 year ago

rom1504 commented 1 year ago

this was discussed many times, the current answer is not systematically

if it is used to explain a few complicated functions it makes sense
if it increases the number of lines of code while not clarifying much, it's not good
the api.md file is still the gold standard and must be updated