Is the @example in roxygen equivalent to a doctest in Python? Is it intended to be used in the same way and what are potential differences?

Assuming your uses of doctest in Python ~match up with those described here , which are summed up at the end as: Checking examples in docstrings. Regression testing. Executable documentation / literate testing. there is some overlap. In the Writing R documentation files section of Writing R Exte…

Hi Mara, thank you so much for your comprehensive answer. It made things a lot clearer to me and is very helpful.

Posit Community

Roxygen `@example` comparable to Python doctest?

General

roxygen2

show post in topic

Home
Categories
Guidelines
Terms of Service
Privacy Policy

Powered by Discourse, best viewed with JavaScript enabled