search

Bioconductor / bioc_mentorship_docs

Training materials for mentors and mentees
https://Bioconductor.github.io/bioc_mentorship_docs/
2 stars 1 forks source link

Place for developer documentation? #4

Open llrs opened 3 years ago

llrs commented 3 years ago

Proper place for developer documentation? HACKING.md / README.md / ...?

On Github there is a Contributing file that receive special attention. But the README can be also a good file to have some short instructions to other (old and potential) contributors.

Other good way is to document functions but not export them or display the help page on the manual (via @noRd if using roxygen2.

kevinrue commented 3 years ago

@llrs your link to @nord points to a github account that doesn't have any public repository. Is that supposed to be a roxygen2 command? (I'm not familiar with it myself).

Ahhhh.. I think I know what you mean. @noRd (e.g. https://stackoverflow.com/questions/62943917/roxygen2-nord-tag-has-no-effect-in-presence-of-the-rdname-tag-in-documenting)

llrs commented 3 years ago

Yes it is a different roxygen2 tag (@ noRd) without the space between it