search

jefferislab / catnat

neuroanatomy toolbox – CATMAID extension functions
https://jefferislab.github.io/catnat
1 stars 2 forks source link

Documentation improvements #8

Open jefferis opened 5 years ago

jefferis commented 5 years ago

If anyone is going to use this package, we should try to improve the documentation a bit. I have added a pkgdown online documentation site. See e.g. https://pkgdown.r-lib.org/articles/pkgdown.html for config details.

You will see there are currently lots of duplicate doc errors (some functions are defined 3x) and also a bunch if incorrectly documented args. it would be good to fix.

jefferis commented 5 years ago

Also the pkgdown site allows functions to be grouped rather than just listed in alphabetical order. If you edit _pkgdown.yml you can change the grouping/ordering.

alexanderbates commented 5 years ago

Okay great! this has been on my mental todo list for a while, but some elements of the package are rather experimental, so I might not clear all of it up in the coming days.

jefferis commented 5 years ago

OK. If you turn on GitHub pages for the docs branch or just give me full access to the repo, I can do a bit of gardening.

alexanderbates commented 5 years ago

To do that, should I transfer ownership to jefferislab?

jefferis commented 5 years ago

You could. Or just change the collaboration settings for this repo.

Sent from my iPhone

On 9 Mar 2019, at 17:39, Alexander Bates notifications@github.com wrote:

To do that, should I transfer ownership to jefferislab?

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub, or mute the thread.

alexanderbates commented 5 years ago

I can't see how to change collaborator settings, I think you can't at least on a free private account. I have transferred to jefferislab