Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation is too terse #5

Open
lucmp opened this issue Jul 12, 2023 · 1 comment
Open

Documentation is too terse #5

lucmp opened this issue Jul 12, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@lucmp
Copy link

lucmp commented Jul 12, 2023

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."

@theletterf theletterf added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jul 12, 2023
@Myndex
Copy link

Myndex commented Jul 12, 2023

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?"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants