datashader icon indicating copy to clipboard operation
datashader copied to clipboard

Documentation for hammer_bundle

Open ivirshup opened this issue 5 years ago • 2 comments

This is a feature request for the documentation for hammer_bundle to be expanded. I was just playing around with it, when I noticed a couple of the parameters doc-strings just ended with ellipses, or have questions in them. It'd be nice to have some guidance on how the parameters will effect the plot.

I believe this was noticed before here: https://github.com/pyviz/datashader/pull/369#issuecomment-306879605.

By the way, I'm really liking the new "Getting Started" guide!

ivirshup avatar Apr 10 '19 07:04 ivirshup

Alas, the people who previously worked on hammer bundling are no longer working on the project, and so I'm afraid that you have as much insight as we do about the docstrings! I'd be happy to work with you to work out good docstrings (sorry I've been so busy the past few weeks; should be easing up now!) and get those merged.

Glad you like the getting started guide!

jbednar avatar Apr 10 '19 15:04 jbednar

I'm definitely tempted, but it'd likely be a little while until I have time to get through the paper and the code. If I were to rewrite the docs, I'd probably also look into speeding up the whole method while I'm at it.

ivirshup avatar Apr 16 '19 06:04 ivirshup