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.

Sign up for GitHub

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

Jump to bottom

DOC: Readme updates #460

Merged
merged 15 commits into from
Jun 21, 2021
Merged

DOC: Readme updates #460

merged 15 commits into from
Jun 21, 2021

Conversation

itrharrison
Copy link
Contributor

@itrharrison itrharrison commented Apr 22, 2021 •
edited
Loading

Description

This PR adds information to the README.

  • The first paragraph is expanded based on comments received on the JOSS paper to more specifically state the uses of SkyPy.
  • The main_functionalities documentation page added in response to a JOSS paper comment is linked (see Comprehensive List of Features - JOSS Review #443)
  • The 'Get in Touch' section has been added. This requires the external actions of enabling the Discussions tab and setting up the email address (see Create points of contact for SkyPy #459)

Checklist

  • Follow the Contributor Guidelines
  • Write unit tests
  • Write documentation strings
  • Assign someone from your working team to review this pull request
  • Assign someone from the infrastructure team to review this pull request

@itrharrison itrharrison added documentation Improvements or additions to documentation coordinators labels Apr 22, 2021
@itrharrison itrharrison requested review from laurawolz and rrjbca April 22, 2021 14:16
@itrharrison itrharrison self-assigned this Apr 22, 2021
laurawolz
laurawolz reviewed Apr 22, 2021
View reviewed changes
README.rst Outdated Show resolved Hide resolved
Lucia-Fonseca
Lucia-Fonseca requested changes Apr 22, 2021
View reviewed changes
README.rst Outdated Show resolved Hide resolved
README.rst Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
sibirrer
sibirrer reviewed Apr 22, 2021
View reviewed changes
README.rst Outdated Show resolved Hide resolved
rrjbca
rrjbca requested changes Jun 21, 2021
View reviewed changes
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
@rrjbca rrjbca changed the title Readme updates DOC: Readme updates Jun 21, 2021
Lucia-Fonseca
Lucia-Fonseca approved these changes Jun 21, 2021
View reviewed changes
Copy link
Member

@Lucia-Fonseca Lucia-Fonseca left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good to go.

@rrjbca rrjbca merged commit 39f5a2b into skypyproject:main Jun 21, 2021
@rrjbca rrjbca mentioned this pull request Aug 31, 2021
Closed
itrharrison added a commit that referenced this pull request Dec 15, 2022
@itrharrison @rrjbca
@ntessore @Lucia-Fonseca @sutieng @philipp128 @Fox-Davidson
MAINT: merge main into module/halos (#581)
3496ac0 
* Update name of default branch to main (#434)

* update mailmap (#432)

* Write all tables to a single FITS/HDF5 file (#425)

* ADR 3: Position sampling and patches of the sky (#422)

* BUG: Raise ImportError if optional dependency speclite is not installed (#437)

* MAINT: Set NumPy latest supported version to 1.20 #440

* Update status badges (#441)

* MAINT: Update Lucia affiliation (#451)

* MAINT: add SIT's information (#450)

* DOC: Fix contributor guidelines link (#449)

Co-authored-by: Richard R <[email protected]>
Co-authored-by: Nicolas Tessore <[email protected]>

* ENH: Logging for skypy command line script and Pipeline class (#453)

* DOC: Describe speclite filters in documentation (#457)

* ENH: Config syntax for importing objects (#463)

* DOC: List of Features (#456)

* DOC: How to construct config files (#454)

* DOC: Remove docstring examples (#429)

* MAINT: Update Zenodo entry for RPR (#468)

* DOC: Readme updates (#460)

* DOC: Expanded landing page documentation (#228)

* DOC: Inverse transform sampling accuracy warning (#472)

* MAINT: Set astropy latest supported version to 4.2 (#483)

* DOC: zenodo json members update (#481)

* DOC: Ryden04 ellipticity doc missing section (#477)

* MAINT: Update numpy and scipy latest supported versions (#488)

* BUG: Change invalid ecsv datatype from int to uint16 (#485)

* DEV: setuptools==58.0.0 (#493)

Co-authored-by: Nicolas Tessore <[email protected]>

* Add compatibility workflow badge (#487)

* DEV: Enable pip to install pre-releases in the tox dev environments (#491)

* TST: Use tmp_path fixture for temporary files in unit tests (#489)

* BUG: Move handling of context arguments after handling of .depends keyword (#465)

* BLD: Set astropy latest supported version to 4.3 and speclite minversion to 0.14 (#486)

* REV: restore setuptools to latest version on readthedocs (#494)

* DEV: pyparsing<3.0.0 (#500)

* Check new astropy file overwrite error message in logging test (#498)

* REV: restore pyparsing to latest version for doc builds (#501)

* DOC: Update citation file with JOSS paper reference (#496)

* BLD: Set astropy latest supported version to 5.0 (#504)

* BLD: Set python latest supported version to 3.10 (#505)

* BLD: Set numpy latest supported version to 1.22 (#506)

* BLD: Set python oldest supported version to 3.7 (#507)

* DOC: Fix code of conduct link (#508)

* Changed y-label in luminosity function example. (#512)

* BLD: Set scipy latest supported version to 1.8 (#510)

* ENH: Rykoff model of the magnitude uncertainty (#526)

* TST: assert photometric error is numerically close to the analytic value (#545)

* TST: Drop deprecated astropy.tests.helper.raises (#546)

* ENH: compute kcorrect remaining stellar mass (#476)

* compute kcorrect remaining stellar mass

* added test for stellar mass remain

Co-authored-by: Ian Harrison <[email protected]>
Co-authored-by: Lucia F. de la Bella <[email protected]>

* ENH: Logistic completeness function (#521)

* BLD: Set astropy latest supported version to 5.1 (#547)

* BUG: `schechter_smf` callable input and docs (#525)

* DOC: Typo in Rykoff error (#550)

* add Fox's details (#551)

Co-authored-by: Richard R <[email protected]>

* BLD: Set numpy latest supported version to 1.23 (#552)

* codestyle fixes

* add six requirement for colossus

* tried to fix docs builds

* update passenv

* rtd configuration

Co-authored-by: Richard R <[email protected]>
Co-authored-by: Nicolas Tessore <[email protected]>
Co-authored-by: Lucia F. de la Bella <[email protected]>
Co-authored-by: Sut-Ieng Tam <[email protected]>
Co-authored-by: philipp128 <[email protected]>
Co-authored-by: Fox Davidson <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@laurawolz laurawolz laurawolz left review comments

@sibirrer sibirrer sibirrer left review comments

@rrjbca rrjbca rrjbca approved these changes

@Lucia-Fonseca Lucia-Fonseca Lucia-Fonseca approved these changes

@ntessore ntessore ntessore approved these changes

Assignees

@itrharrison itrharrison

Labels
coordinators documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@itrharrison @ntessore @sibirrer @laurawolz @Lucia-Fonseca @rrjbca