Skip to content

/ pkgnet

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

Jump to bottom

Reorganize roxygen documentation for reporters #192

Closed
jayqi opened this issue Feb 23, 2019 · 0 comments
Closed

Reorganize roxygen documentation for reporters #192

jayqi opened this issue Feb 23, 2019 · 0 comments
Labels
documentation ux
Milestone
Release v0.4.0

Comments

@jayqi
Copy link
Collaborator

@jayqi jayqi commented Feb 23, 2019

The roxygen documentation for reporters is not especially usable. Documentation on methods is spread out across the articles for the Abstract classes where they are implemented, and the articles for the user-facing reporters are barebones.

I propose we create comprehensive roxygen docs for each of the user-facing reporters by stitching together sections with @inheritSection. See the roxygen for DirectedGraph for what I'm thinking.
@jayqi jayqi mentioned this issue Mar 3, 2019
Merged
@jayqi jayqi modified the milestone: Release v0.4.0 Mar 29, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation ux
Projects
None yet
Milestone
Release v0.4.0
Linked pull requests

Successfully merging a pull request may close this issue.

Roxygen documentation rewrite
1 participant
@jayqi
You can’t perform that action at this time.