Improve docs

[carstenbauer]

As promised in #8, I made my pass over the docs. Let me know what you think!

Open things to do/decide:

• The image needs to be improved (see #8). I'll leave that to you.
• I think the entire Lower-level chunks function section is unnecessarily verbose. More importantly, I think that the variant chunks(array::AbstractArray, ichunk::Int, nchunks::Int, type::Symbol=:batch) is a misnomer anyways, because it doesn't return chunks but just a single chunk. It is essentially a getchunk function and I wonder why it isn't named this way. For now, I've left it as is and leave the improvement of this API and the corresponding docs section for a future PR (not necessarily by myself).

Close #8

[lmiq]

• is a misnomer anyways, because it doesn't return chunks but just a single chunk. It is essentially a getchunk function and I wonder why it isn't named this way

I agree. I can change that at some point (of course it would be breaking). I will update the figure with your suggestions asap.

[lmiq]

Thank you very much for the contributions.

[lmiq]

Just to give some feedback: I have now updated (hopefully) everything you suggested in the docs, including the figure. Also, I have released a breaking version 2 of the package renaming the lower-level function chunks to getchunk, as you suggested, and I already created pull requests on all packages that depended on it to update the compat entries (none was affected by the change).

At some point, I'm not sure if it would be more reasonable to move this package to some organization (any suggestion?). I created it for my personal use and it found utility for others, but it carries some functionality which is beyond what I can, obviously, improve significantly. I never transferred packages to other organizations than my own, but if you have any suggestion and participate on any in which this package fits, I'll be happy to move it such that it has better long term maintainability.