From 3edda4ab47a43a2c014d8fa00655387bc8b0e7fe Mon Sep 17 00:00:00 2001 From: kelle Date: Thu, 23 Dec 2021 11:27:18 -0500 Subject: [PATCH 1/2] add words about citations in Documentation --- affiliated/affiliated_package_review_guidelines.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/affiliated/affiliated_package_review_guidelines.md b/affiliated/affiliated_package_review_guidelines.md index 7a81ae46..8f165b4c 100644 --- a/affiliated/affiliated_package_review_guidelines.md +++ b/affiliated/affiliated_package_review_guidelines.md @@ -106,7 +106,11 @@ it exists) and see how the package fares: Green -Extensive documentation, including at least: motivation/scope of package, installation instructions, usage examples, API documentation. In terms of infrastructure, the documentation should be automatically built on readthedocs.org. If appropriate, one or more tutorials should be included in the Astropy tutorials at http://tutorials.astropy.org. +Extensive documentation, including at least: motivation/scope of package, installation instructions, usage examples, +API documentation. +A preferred method of citation of this package and citations to relevant papers and software included where appropriate. +In terms of infrastructure, the documentation should be automatically built on readthedocs.org. +If appropriate, one or more tutorials should be included in the Astropy tutorials at http://tutorials.astropy.org. From a9ea09ccd27703ea3ef2a80a811a5f70f91bc94b Mon Sep 17 00:00:00 2001 From: kelle Date: Thu, 23 Dec 2021 11:30:56 -0500 Subject: [PATCH 2/2] fix spacing --- affiliated/affiliated_package_review_guidelines.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/affiliated/affiliated_package_review_guidelines.md b/affiliated/affiliated_package_review_guidelines.md index 8f165b4c..96706f05 100644 --- a/affiliated/affiliated_package_review_guidelines.md +++ b/affiliated/affiliated_package_review_guidelines.md @@ -106,8 +106,8 @@ it exists) and see how the package fares: Green -Extensive documentation, including at least: motivation/scope of package, installation instructions, usage examples, -API documentation. +Extensive documentation, including at least: motivation/scope of package, installation instructions, +usage examples, and API documentation. A preferred method of citation of this package and citations to relevant papers and software included where appropriate. In terms of infrastructure, the documentation should be automatically built on readthedocs.org. If appropriate, one or more tutorials should be included in the Astropy tutorials at http://tutorials.astropy.org.