dgobalak / dgobalak/File-Insights

Improving class and function documentation

Open
#8 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

- [ ] Document classes and functions using docstrings according to [this Google example](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html)
- [x] Make sure the code is well commented, especially any complex logic.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.