search

lhenneman / hyspdisp

4 stars 5 forks source link

Documentation - Develop a better Roxygen #23

Open schoolAccountMajaG opened 5 years ago

schoolAccountMajaG commented 5 years ago

We should write nice documentation for the package. For now, it might sometimes be difficult to know what functions do.

cchoirat commented 5 years ago

You might want to take a look at https://github.com/r-lib/pkgdown.

On Wed, Jun 12, 2019 at 2:38 PM Maja notifications@github.com wrote:

We should write nice documentation for the package. For now, it might sometimes be difficult to know what functions do.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/lhenneman/hyspdisp/issues/23?email_source=notifications&email_token=AA73AZKZCKYPCNR7XAU7Y7TP2DU3ZA5CNFSM4HXIQ572YY3PNVWWK3TUL52HS4DFUVEXG43VMWVGG33NNVSW45C7NFSM4GZBUMDA, or mute the thread https://github.com/notifications/unsubscribe-auth/AA73AZO5O722FPQONZARKYLP2DU3ZANCNFSM4HXIQ57Q .

cchoirat commented 5 years ago

Do you mean polishing the vignette?

Adding a https://cran.r-project.org/web/packages/roxygen2/vignettes/roxygen2.html to functions?

Both?

schoolAccountMajaG commented 5 years ago

both. The functions have some roxygen but limited.

cchoirat commented 5 years ago

I suggest you open distinct issues then