search

traversc / qs

Quick serialization of R objects
397 stars 19 forks source link

Improve roxygen2 usage #58

Closed salim-b closed 2 years ago

salim-b commented 2 years ago

This PR relies on various modern roxygen2 features to simplify and streamline documentation and reduce duplications. There were also a bunch of documentation errors/mistakes that this PR fixes as well as various spelling harmonizations.

Note that unfortunately we can't use @inheritParams since

roxygen2 doesn't parse the usage block, so it doesn't know what the usage is, and hence it doesn't find any parameters to inherit.

Instead we use @eval to minimize duplication.

Also note that Markdown support in roxygen2 documentation tags is now enabled globally for the whole package which means percentage signs (%) mustn't be escaped anymore.

traversc commented 2 years ago

This pretty cool, I need to re-learn roxygen2. Thanks for all the fixes, if you want to add yourself to the authors list feel free to.

salim-b commented 2 years ago

Glad to hear! 🙃 Took me quite a while in the end to put together all the changes, but I couldn't stop just in the middle.

if you want to add yourself to the authors list feel free to.

Thanks, I've just submitted https://github.com/traversc/qs/pull/59 😄

And BTW, thank you for developing this awesome package!!