theletterf / english-lang

The English Programming Language
https://en.wikipedia.org/wiki/English_language
465 stars 11 forks source link

Documentation is too terse #5

Open lucmp opened 1 year ago

lucmp commented 1 year ago

One can argue that it takes time to produce good documentation, but why does the only example provided have to be so complex? Why not stick to tried and tested traditions such as

"Hello, World!" "The book is on the table." "Nice to meet you."

then move on to more elaborate examples such as

"Peter Piper picked a peck of pickled peppers." "She sells sea shells by the sea shore." "Madam, I'm Adam."

Myndex commented 1 year ago

Hi @lucmp

The body of your issue seems to be at odds with the title, as your issue is suggesting terce examples… Perhaps I am missing something, but from context it seems that the title change might be "documentation examples are too verbose?"