klmr / klmr/box

“help” shows incorrect/incomplete documentation

Open
#169 0 comments 0 reactions 1 assignee Claimed by @klmr View on GitHub
⚠️ bug
Dominant language
R
Stars
979
Forks
49
PR merge metrics
No merged PRs in 30d

Description

The documentation being produced and attached to a module namespace is incomplete and uses the wrong formatting. Adding a new paragraph after a `@param` adds the new paragraph’s text to the parameter description, rather than creating a “Details” section. Other sections (such as `@example`) are missing entirely.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.