Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
jameslamb opened this issue May 2, 2020 · 0 comments
Closed

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

jameslamb opened this issue May 2, 2020 · 0 comments

Comments

@jameslamb
Copy link
Collaborator

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants