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

Update the package description. #115

Merged
merged 3 commits into from
Oct 31, 2023
Merged

Conversation

Moohan
Copy link
Member

@Moohan Moohan commented Oct 3, 2023

The notes from the CRAN maintainer were:

The Description field is intended to be a (one paragraph) description of what the package does and why it may be useful. Please add more details about the package functionality and implemented methods in your Description text.

The only guidelines I found otherwise were:

  • It is a single paragraph.
  • It is informative and concise, and it clearly describes what the package does and why it is useful.
  • It does not include the package name.
  • It does not start with "A package for ..." or "This package does ...".
  • It is written in plain text, with no markup.
  • It is indented correctly, with each line no more than 80 characters wide.
  • It includes relevant citations, formatted in the correct style.
  • It is free of errors in grammar and spelling.

The notes from the CRAN maintainer were:

> The Description field is intended to be a (one paragraph) description of what the package does and why it may be useful. Please add more details about the package functionality and implemented methods in your Description text.

The only guidelines I found otherwise were:

 * It is a single paragraph.
 * It is informative and concise, and it clearly describes what the package does and why it is useful.
 * It does not include the package name.
 * It does not start with "A package for ..." or "This package does ...".
 * It is written in plain text, with no markup.
 * It is indented correctly, with each line no more than 80 characters wide.
 * It includes relevant citations, formatted in the correct style.
 * It is free of errors in grammar and spelling.
@Moohan Moohan requested a review from Tina815 October 3, 2023 09:26
@Tina815 Tina815 merged commit 6e1f13c into master Oct 31, 2023
15 checks passed
@Tina815 Tina815 deleted the cran/update-package-description branch October 31, 2023 14:06
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

Successfully merging this pull request may close these issues.

2 participants