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

Make current documentation more verbose #46

Open
lcolladotor opened this issue Dec 1, 2023 · 0 comments
Open

Make current documentation more verbose #46

lcolladotor opened this issue Dec 1, 2023 · 0 comments
Labels
enhancement New feature or request
Milestone

Comments

@lcolladotor
Copy link
Owner

Several functions in biocthis are sparsely documented and refer users to documentation from other packages such as usethis. This is also noticeable on the main user guide at https://lcolladotor.github.io/biocthis/articles/biocthis.html.

We plan to expand the documentation and be more verbose such that users will have understand biocthis functions without having to go to other sources of documentation. Of course, we will still refer to external sources of documentation such that users can dive into further details if they want to do so. But the main idea should still be documented in biocthis.

@lcolladotor lcolladotor added the enhancement New feature or request label Dec 1, 2023
@lcolladotor lcolladotor added this to the bioc v3.20 milestone Dec 1, 2023
@lcolladotor lcolladotor moved this to Todo in biocthis plans Dec 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Todo
Development

No branches or pull requests

1 participant