Remove inline code style for package names

elong0527 / r4csr

R for Clinical Study Report and Submission

https://r4csr.org/

Other

70 stars 33 forks source link

Remove inline code style for package names #91

Closed nanxstats closed 1 year ago

nanxstats commented 1 year ago

I suggest we make a consistency fix to not stylize R package names as inline code, such as r2rtf.

This would make it consistent with the styling practices in Hadley's books, such as adv-r, r-pkgs, ggplot2-book.

Since we are using package names a lot in the text, I also don't think rendering them as emphasized text (bold or italic) is optimal. See bold or italic for the reasoning.

@elong0527 What do you think?

elong0527 commented 1 year ago

I can make the change, what’s the recommendation for package name style?

nanxstats commented 1 year ago

Good. I can provide two data points:

In Hadley's books, package names are not stylized at all.
In Yihui's books, package names are bold.

So it's up to you. Personally I feel not styling at all makes more sense as it's much less visual burden when package names are mentioned a lot.

nanxstats commented 1 year ago

Fixed by https://github.com/elong0527/r4csr/pull/94