Skip to content
This repository has been archived by the owner on Jun 3, 2020. It is now read-only.

Add docstrings (and type annotations ?) #30

Open
mhugo opened this issue Jan 21, 2020 · 1 comment
Open

Add docstrings (and type annotations ?) #30

mhugo opened this issue Jan 21, 2020 · 1 comment

Comments

@mhugo
Copy link
Contributor

mhugo commented Jan 21, 2020

The project is growing and the overall readability is not really enhancing ...

At the minimum add docstrings to document function usage and parameter types.

Maybe we should investigate the use of type annotations ? at least to highlight areas where the typing is a bit too much dynamic or not clear (It is already not very clear which functions take a regular dict from those which take PlotConfig)

@troopa81
Copy link
Contributor

troopa81 commented Feb 5, 2020

docstring seems a good idea. I'm unsure about annotations, I never used so maybe we can give it a try

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants