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

Comments in source code #21

Open
cschweda opened this issue Jun 4, 2021 · 2 comments
Open

Comments in source code #21

cschweda opened this issue Jun 4, 2021 · 2 comments
Labels
documentation Improvements or additions to documentation useability Issue with use

Comments

@cschweda
Copy link
Contributor

cschweda commented Jun 4, 2021

Is your feature request related to a specific use case? Please describe.
In the words of Steve Ballmer, "Developers, developers, developers."

Describe the solution you'd like
Would it possible to provide (a few more) comments in the source code?

Especially:

Additional context
Nothing detailed -- just a few general guidelines at what's happening at various points. Especially the parser.

How would this help?
This would assist with ad hoc debugging -- as well as future developers (in addition to folks who might fork the repo).

Thank you! :)

@cschweda cschweda added documentation Improvements or additions to documentation useability Issue with use labels Jun 4, 2021
@miserman
Copy link
Contributor

miserman commented Jun 4, 2021

This will definitely be part of the plan for this month, along with more implementation details in the readme and/or on the documentation site.

@kgruschow
Copy link
Contributor

this is at medium priority, where for clarification priority is essentially: high priority > documentation > other accessibility and major UI issues > other issues

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 useability Issue with use
Projects
None yet
Development

No branches or pull requests

3 participants