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

Better documentation 📝 #23

Open
7 of 9 tasks
jakobbossek opened this issue Jun 2, 2021 · 0 comments
Open
7 of 9 tasks

Better documentation 📝 #23

jakobbossek opened this issue Jun 2, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@jakobbossek
Copy link
Owner

jakobbossek commented Jun 2, 2021

  • For some weird reason, for the return value of a function, the indentation seems broken.
  • Not happy anymore with the way expected data types for arguments are stated. E.g. x [numeric(1)] might be clear for an experienced user, but not a less experienced R rookie.
  • Currently, many technical details are given in the @description field. This should rather go under @details, right? Description should hold some information on what the function actually does.
  • There should be DOIs for all referenced papers and DOIs should be links.
  • Sometimes titles have a trailing dot, sometimes not. What is the recommendation here?
  • It looks weird if for the return value only the data type is reported. We should do this more R-like even if the result is obvious.
  • Function hv lacks a reference.
  • Examples for log_init need line-breaks
  • The index looks very full due to @seealso and @family.
@jakobbossek jakobbossek changed the title Minor documentation issues: Better documentation 📝 Jun 2, 2021
@jakobbossek jakobbossek added the documentation Improvements or additions to documentation label Jun 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant