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

Provide at least one example for each field in DESCRIPTION #5

Open
kevinrue opened this issue Jul 4, 2021 · 2 comments
Open

Provide at least one example for each field in DESCRIPTION #5

kevinrue opened this issue Jul 4, 2021 · 2 comments

Comments

@kevinrue
Copy link
Collaborator

kevinrue commented Jul 4, 2021

In chapter: https://bioconductor.github.io/pkgrevdocs/description.html

@lshep
Copy link
Contributor

lshep commented Sep 2, 2021

Or just a full complete description even with optional fields.

@kevinrue
Copy link
Collaborator Author

kevinrue commented Sep 2, 2021

One full example would be helpful as an overview, but I'm worried that it would not be sufficient to illustrate specific points (e.g. good and bad examples for certain fields). In particular, for specific fields, snippets take away the distraction of surrounding fields that are irrelevant to the point being made.

Summary:

  • a complete description with all possible fields is a great idea
  • I would still encourage snippets as examples for individual fields

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

2 participants