search

laserson / squarify

Pure Python implementation of the squarify treemap layout algorithm
Other
297 stars 37 forks source link

add margin between section in readme #40

Closed JosephBARBIERDARNAL closed 1 week ago

JosephBARBIERDARNAL commented 1 month ago

related to: #38

laserson commented 1 month ago

Thanks for contributing this @JosephBARBIERDARNAL, but I actually find the changes to be a little bit less clear. Something that would be a net positive would be something more along the lines of the click API docs (and also autogenerated). Let me know if you want to try doing that instead.

JosephBARBIERDARNAL commented 1 month ago

Just to be sure, do you mean something that uses docstrings to automatically write the readme? If so, that can probably be done with tools like pdoc.

But I didn't understand the part about the click API. You mean you like their style of documentation?

Also, what's your thought on adding use cases with image output?

laserson commented 1 month ago

Just to be sure, do you mean something that uses docstrings to automatically write the readme? If so, that can probably be done with tools like pdoc.

But I didn't understand the part about the click API. You mean you like their style of documentation?

Yes, something in the style of the Click API docs or the Requests API docs. Autogenerated would be great, and dumped into the README.

Also, what's your thought on adding use cases with image output?

Fine, but something super-simple. So could just add a figure output from the Example that's already in the README.

JosephBARBIERDARNAL commented 1 month ago

Got it. I’ll try to suggest something soon for this.

JosephBARBIERDARNAL commented 1 week ago

Hey @laserson! I'm very busy at the moment, so I suggest we close this for now. When I've found enough time, I'll try to reopen a PR with your suggestions. Is that okay with you?

laserson commented 1 week ago

That works for me! Good luck!