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.

Sign up for GitHub

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

Jump to bottom

Introduce "Description" section header #38

Closed
dgkf opened this issue Jan 10, 2025 · 1 comment · Fixed by #40
Closed

Introduce "Description" section header #38

dgkf opened this issue Jan 10, 2025 · 1 comment · Fixed by #40
Assignees
@maksymiuks

Comments

@dgkf
Copy link
Collaborator

dgkf commented Jan 10, 2025

I don't recall an explicit reason why this was omitted.

{pkgdown} output excludes it, but tools::Rd2txt includes it.

Since it doesn't seem to be standardized, I think we could either default to printing it or make it a global option?
@mannau
Copy link

mannau commented Jan 16, 2025

Printing the header would imho be the better default behaviour. Any updates on this?

@maksymiuks maksymiuks self-assigned this Jan 17, 2025
@maksymiuks maksymiuks mentioned this issue Jan 20, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@maksymiuks maksymiuks

Labels
None yet
Projects
None yet
Milestone
No milestone
3 participants
@mannau @dgkf @maksymiuks