search

ropensci / taxize

A taxonomic toolbelt for R
https://docs.ropensci.org/taxize
Other
269 stars 61 forks source link

switch pkg to use markdown docs #658

Closed sckott closed 5 years ago

alanocallaghan commented 6 years ago

Can you elaborate on this a bit @sckott ?

jarioksa commented 6 years ago

Yeah, I'm baffled, too. rmarkdown is a tool: why should you change the final product (docs) just to use another tool for a similar result?

Rekyt commented 6 years ago

I think that @sckott means to change the documentation that is generated by roxygen2 to use markdown format (see more about it in this vignette of roxygen2)

sckott commented 6 years ago

yes, to use markdown formatting instead of latex. i think it's easier for everyone to contribute when it's markdown. in addition, it usually takes up less characters so it's easier less text. I'm not sure i see a downside other than the work that goes into it.

the only caveat is markdown doesn't work in templates AFAIK https://github.com/ropensci/taxize/tree/master/man-roxygen

@Alanocallaghan if you're interested in contributing you can look at that link for how to use markdown

alanocallaghan commented 6 years ago

You mean to change the roxygen docs to use Markdown formatting ("`id`") instead of latex ("\code{id}")?

sckott commented 6 years ago

@Alanocallaghan Yes, that's one example.

alanocallaghan commented 6 years ago

Alrighty, I'll try to get that done asap. Thanks for clarifying.

sckott commented 6 years ago

@Alanocallaghan thanks. i'd suggest doing a one or a few files in a small pull request instead of trying for all of them in 1 PR - and go from there if the first one goes well