Improve NVDA's coding standards

[SaschaCowley]

Link to issue number:

Summary of the issue:

NVDA's coding standards are light on details regarding exactly where certain things should be documented. They also contain no information on acceptable use of language.

Description of user facing changes

The coding standards have been updated to:

• Clarify that Python class constructors should be documented in the class's __init__, not in the class's docstring;
• Clarify that Python class attributes should be documented immediately below where they're first declared/defined, not in the class's docstring;
• Add a statement on types of language that should be avoided in new code submissions, with examples and alternatives.

Description of development approach

Docstrings: Looked at our current approach.

Language usage: The following resources were consulted:

• https://it.uw.edu/guides/identity-diversity-inclusion/inclusive-language-guide/
• https://blogs.cisco.com/developer/inclusivelanguage01
• https://www.aswf.io/blog/inclusive-language/
• https://betterprogramming.pub/inclusive-code-struction-a-how-to-guide-51dc95867e05

Testing strategy:

Known issues with pull request:

Code Review Checklist:

• Documentation:
  • Change log entry
  • User Documentation
  • Developer / Technical Documentation
  • Context sensitive help for GUI changes
• Testing:
  • Unit tests
  • System (end to end) tests
  • Manual testing
• UX of all users considered:
  • Speech
  • Braille
  • Low Vision
  • Different web browsers
  • Localization in other languages / culture than English
• API is compatible with existing add-ons.
• Security precautions taken.

@coderabbitai summary

[seanbudd]

Nice stuff!

[gerald-hartig]

Nice work @SaschaCowley