Materials for formatting and stylizing documentation?

Package development
1

Hello,

Is there any recommended resources I could look at for how to stylize my documentation? I am looking for how to stylize certain words in certain situations;

  • R functions/variables, wrap them in a code format; my_var

Those are straightforward, but I struggle with how to stylize database names, database table names, etc. I would love to see reference material that helps standardize stylizing documentation.

Appreciate the time!

Kyle

2

{roxygen} to draft, Quarto edit and embellish.

3

The tidyverse style guide might help with some of this, see for instance 7 Documentation | The tidyverse style guide

1 Like
4

I realize it helps with what you already know, though, sorry :sweat_smile:

1 Like
5

This topic was automatically closed after 45 days. New replies are no longer allowed.


If you have a query related to it or one of the replies, start a new topic and refer back with a link.