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

Incomplete Documentation #27

Open
pearsonca opened this issue Feb 6, 2020 · 0 comments
Open

Incomplete Documentation #27

pearsonca opened this issue Feb 6, 2020 · 0 comments

Comments

@pearsonca
Copy link
Collaborator

pearsonca commented Feb 6, 2020 •
edited
Loading

The documentation is generally incomplete.

While it has the appearance of completeness, it does not include critical elements:

  • params should specific what class of object. e.g., @param num.initial.cases integer vector: the number of initial cases
  • ibid for function inputs, indicating function(x), x integer, returns y double
  • document what class of object is being returned, and for tables / named objects, what columns, names will be present

More @examples would be nice (and required for CRAN), but not strictly necessary
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@pearsonca