Assessment: The grader randomly opens application files (not test files) to check that all public classes and methods are well documented (hints
Links to an external site.). In addition, the grader checks that the corresponding API documentation has been generated in a browsable format (eg HTML when using Javadoc).
Cyrille's comment:
Use doc strings so you can run pydoc. Document how to run pydoc (and for which version of Python) and/or put the result in the repo or a web page that is reachable from the README. Document the purpose and functionality of each public method. Additional documentation inside a method is good, but documentation on the "outside" is mandatory.
Property (SE): the program is properly documented
Assessment: The grader randomly opens application files (not test files) to check that all public classes and methods are well documented (hints Links to an external site.). In addition, the grader checks that the corresponding API documentation has been generated in a browsable format (eg HTML when using Javadoc).
Cyrille's comment: Use doc strings so you can run pydoc. Document how to run pydoc (and for which version of Python) and/or put the result in the repo or a web page that is reachable from the README. Document the purpose and functionality of each public method. Additional documentation inside a method is good, but documentation on the "outside" is mandatory.