Add docstrings to all functions in SDG build

open-sdg / sdg-build

Python package to convert SDG-related data and metadata between formats

MIT License

5 stars 23 forks source link

Add docstrings to all functions in SDG build #204

Open jwestw opened 3 years ago

jwestw commented 3 years ago

While some of the functions are very well documented in docstrings, others are not at all.

I suggest I go through and make docstrings for all of them, in line with best practice.

This is something I could do, though I would probably need clarification sometimes.

brockfanning commented 3 years ago

This sounds good to me. I would love to eventually get some sort of automated documentation going. I've never tried that with Python, but I guess it relies on some sort of a standard approach to these docstrings?