search

laserson / squarify

Pure Python implementation of the squarify treemap layout algorithm
Other
293 stars 36 forks source link

Add documentation file instead of asking users to read the docstrings #25

Closed carlinmack closed 3 years ago

carlinmack commented 3 years ago

I principally generated the file with pdoc and then made some tweaks to make it look nicer. Thank you for your module :)

laserson commented 3 years ago

Thanks @carlinmack, this is definitely an improvement!

Considering the content is so short, do you think perhaps you could instead place the "API docs" directly into the README?

carlinmack commented 3 years ago

You're welcome! Made the changes, let me know if there's anything else :)

laserson commented 3 years ago

Great! One final thing before merge: could you just document the pdoc command you used somewhere?

carlinmack commented 3 years ago

It's simply pdoc squarify/__init__.py > doc.md in the top directory :)

laserson commented 3 years ago

We'll consider it documented here in this issue :)

laserson commented 3 years ago

Thanks for the contrib @carlinmack!