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

Function names #1

Open
davebraze opened this issue May 4, 2016 · 1 comment
Open

Function names #1

davebraze opened this issue May 4, 2016 · 1 comment

Comments

@davebraze
Copy link
Owner

davebraze commented May 4, 2016

Function names in this package use lower camelCase. A few functions (transplanted from FDB1), which did not originally conform to that convention, have been renamed so that they comply. The original names are still available as aliases (e.g., function invDnorm with alias inv_dnorm), but the aliases may be removed at some point.

@davebraze
Copy link
Owner Author

davebraze commented Jun 28, 2016

See if I can fix help file index to show only the camelCase versions of function names.
Can this be done with roxygen2 markup? Look into using the following roxygen markup to suppress these entries.

##' @keywords internal 

See http://stackoverflow.com/questions/32457581/how-can-i-hide-the-documentation-of-helper-functions/32841775#32841775

UPDATE 20160630: tried this and it doesn't work for my case. I think it's because I'm using @Rdname to merge the two help sections together.

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

1 participant