uptake / pkgnet

R package for analyzing other R packages via graph representations of their dependencies
https://uptake.github.io/pkgnet/
Other
152 stars 37 forks source link

[docs] Parameter doc section has unnecessary leading `:` #277

Closed jameslamb closed 3 years ago

jameslamb commented 4 years ago

If you run ?pkgnet::InheritanceReport, you'll see a section like this:

image

And the same on the pkgdown site (https://uptake.github.io/pkgnet/reference/InheritanceReporter.html)

image

Since the parameter names are nicely being put in their own left-aligned heading and then the description is indented over, I think we should remove the leading :. It looks out of place.

Not sure if this is affecting other documentation in the project, but whoever picks up this issue should look at all of it.