search

NM-TAFE / dip-programming-prj-advanced-gui-facilitate

Creative Commons Zero v1.0 Universal
2 stars 5 forks source link

Docstrings (Documentation) #51

Open 20095356 opened 3 weeks ago

20095356 commented 3 weeks ago

The app files and unit tests to lack (although already present) sufficient docstrings, which makes the code less readable and maintainable. Adding docstrings will improve code documentation and help future developers understand the purpose of each of the codes and tests. I added docstrings to the classes, methods and functions of the app files as well as the tests; app.py, code_identifier.py, format_fidelity.py, ocr_method.py, code_identifier_test.py and ocr_method_test.py

Additional Information: This change will not affect the functionality of the, but will enhance the overall code quality.

20095356 commented 3 weeks ago

i raised a pull request. https://github.com/NM-TAFE/dip-programming-prj-advanced-gui-facilitate/pull/52