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

Clean the doc #53

Open
thibautjombart opened this issue May 15, 2018 · 0 comments
Open

Clean the doc #53

thibautjombart opened this issue May 15, 2018 · 0 comments

Comments

@thibautjombart
Copy link
Collaborator

The roxygen files as they currently stand are quite messy to read, and it makes error tracking very difficult. We need to clean the doc, remove all superfluous {}, e.g

@details {
bla bla 
\itemize{
  \item{arg:}{this is bla bla a very very long description which is way way way way more than 80 characters}
  \item{anotherarg:}{toto il est beau}
}}

should be

 @details 
bla bla 
\itemize{

  \item arg this is bla bla shorter and 
     on several lines if needed, so that
     we can read it

  \item anotherarg toto il est beau
}

including the lines between items; I have started this on the branch cleandoc

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant