Join GitHub today
GitHub is home to over 36 million developers working together to host and review code, manage projects, and build software together.Sign up
More granular documentation #43
This is essentially a re-opening of #6 (closed due to inactivity). I'm using this package on a project and would like to include more documentation around
I think it would make the most sense for this to be included in the package, but I will document locally if the answer to the following question is "No". Would a PR using
I was thinking of using a similar style as what's used here to document an R6 class and its methods. Using
Thanks for proposing to add documentation :)
I think the last documentation was "just" a rather vignette (about the somewhat even more specialised case of C++ use RcppAnnoy headers). So we could also do a vignette about R use.
I had, as you may have seen (in their repo under an unsolved but of course "closed" issue as that is how they rol), bad luck with more recent
One "minor" irritant is that thanks to templates we have the same code a few times. So we want to make we write to docs just once. A block ending in
I've added a first pass at the documentation in my fork's
I documented on
I wanted to get some clarification on your note before opening up a PR for review.
Was this indicating that you'd like me to take a stab at writing the vignette in my PR or rather that you'd like to include a vignette (to be written by you) in the same release as other documentation?
I interpreted this as "the changes
Will peruse your fork.
Re vignette: there was a "specialed" missing in front of vignette. The vigette is cool, so we could have gone that way. Direct docs are good too.
Re roxygen2: I am fundamentally unhappy about upstream broke a perfectly valid usage patter simply because it didn't fit their mold. I am surviving but it other innocent bystanders (as eg students of mine at deadline of last homework ... ).