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

API docs: detailed docstrings for various classes #6654

Closed
josephsl opened this issue Dec 19, 2016 · 1 comment
Closed

API docs: detailed docstrings for various classes #6654

josephsl opened this issue Dec 19, 2016 · 1 comment
Labels
component/documentation p5 https://github.com/nvaccess/nvda/blob/master/projectDocs/issues/triage.md#priority

Comments

@josephsl
Copy link
Collaborator

Hi,

Briefly mentioned in #6589:

At the moment some important classes does not have associated API docs. This include some controls in Outlook app module, IAccessible objects and others. Thus I propose adding at least a one-liner description for these classes (the more detailed, the better) so we can let new developers have an easier time understanding how these controls work and rationale for including them in NVDA Core.

Thanks.

@jcsteh
Copy link
Contributor

jcsteh commented Dec 22, 2016

I don't think we need to track these things as big "projects". If you identify something that needs a docstring and you want to write it, we'd be grateful for a pull request. If you are trying to reuse or work on something and you don't understand how something works due to poor documentation, please do file an issue so someone who knows the code can fix it. If you're working on some area of code and you see a missing docstring in the area, please feel free to fix it as part of your work. Major code "audits" just aren't an effective use of time and resources at this point, especially relative to other priorities.

Thanks!

@jcsteh jcsteh closed this as completed Dec 22, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component/documentation p5 https://github.com/nvaccess/nvda/blob/master/projectDocs/issues/triage.md#priority
Projects
None yet
Development

No branches or pull requests

3 participants