search

ropensci / taxa

taxonomic classes for R
https://docs.ropensci.org/taxa
Other
48 stars 12 forks source link

Go through docs right before CRAN #54

Closed zachary-foster closed 7 years ago

zachary-foster commented 7 years ago

I am noticing some outdated and inconsistent documentation. We should probably go through it before the CRAN submission, although I fixed some of it.

sckott commented 7 years ago

👍 will also do for the bits I've been maintaining

zachary-foster commented 7 years ago

Cool

Do you use the roxygen comment re-flowing tool (ctrl+shift+/ in rstudio)? I was using it and noticing that is messes up the indentation of the usage examples. I could not use the @usage thing because R cmd check complains about our weird R6/S3 hybrid tactics, so I imitated the @usage section in the description. Just an FYI. If you select the text you want to re flow instead of just putting the cursor there it will leave the rest alone.

sckott commented 7 years ago

I don't use the reflow thing, didn't know about it. do you think i should?

zachary-foster commented 7 years ago

If you want, I like it when it does not mess stuff up. If you just put the cursor in a roxygen block it reflows the whole block, but if you select text, it only reflows that selection. I like using it right after I (re)write a section, but doing the whole block can mess stuff up if you have some custom indentation. I just mention it because it was messing up our custom formatting when I was using it and I just figured that out.