FinancesPy icon indicating copy to clipboard operation
FinancesPy copied to clipboard

Document classes and functions

Open danilomo opened this issue 5 years ago • 2 comments

Currently the project has zero docstrings. It is important, for an API, that each method and class be well documented.

We should make an effort to document the current classes and functions in the project, and require that new public API types and functions be documented before being committed to master.

danilomo avatar Jan 25 '21 19:01 danilomo

With proper docstrings we could have a documentation generated with some tool like sphinx.

mateusrangel avatar Jan 25 '21 22:01 mateusrangel