From 833b2ecaba3a8f186776fc40d4db4740389e6728 Mon Sep 17 00:00:00 2001 From: teald Date: Wed, 21 Aug 2024 13:43:34 -0700 Subject: [PATCH] =?UTF-8?q?docs(misc):=20=F0=9F=9A=A7=20Initial=20response?= =?UTF-8?q?=20commit.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/miscellaneous/pyopensci_response_1.md | 97 ++++++++++++++++++++++ 1 file changed, 97 insertions(+) create mode 100644 docs/miscellaneous/pyopensci_response_1.md diff --git a/docs/miscellaneous/pyopensci_response_1.md b/docs/miscellaneous/pyopensci_response_1.md new file mode 100644 index 00000000..1c02977c --- /dev/null +++ b/docs/miscellaneous/pyopensci_response_1.md @@ -0,0 +1,97 @@ +# Response + +Hi all, I think I've addressed everything covered by the review. Thank you both +for your PRs, issues, and notes here. They've helped immensely so far! + +I'll itemize (for ease of reference) specific response points and how I've fixed them, then summarize other changes to the code. + +## Specific points (review checklist) + +These are in order of reading the responses in the checklist above, with the ~sections in (parentheses). + +[api_short]: https://geminidrsoftware.github.io/astrodata/api_short.html +[add_header_to_table]: https://geminidrsoftware.github.io/astrodata/api/astrodata.add_header_to_table.html +[testing docs]: https://geminidrsoftware.github.io/astrodata/developer/index.html#run-the-tests +[lint workflow]: https://github.com/GeminiDRSoftware/astrodata/blob/main/.github/workflows/lint.yml + + + +1. (Documentation) Examples missing for user-facing functions + 1. All documentation in the ["Common API for Users"][api_short] now + have examples, better explanations, or are deprecated. + 2. Specifically, [`add_header_to_table`][add_header_to_table] has been deprecated, as its functionality is no longer used. It will be removed in version 3.0.0. + 3. Covered in PR #50 + 4. The previous examples directory was a vestigial directory, and has been removed. +2. (Documentation) URLs have been added to `pyproject.toml` + 1. Commit 8f74d89 +3. (Documentation/README) Badges in README now have a repostatus and Python version badge + 1. Commit 6537a51 +4. (Documentation/README) Citation information has been added to the README + 1. Commit b057511 +5. (Functionality/Automated tests) Testing failures + 1. All testing failures encountered were due to intermittent service with the Gemini Archive (which is getting an upgrade!), as well as some issues with Actions and their runner configurations. + 2. Tracked in Issue #16 until updates complete +6. (Functionality/Packaging Instructions) Testing instructions unclear + 1. [Developer documentation][testing docs] has been upgraded to reflect our new testing framework (using `nox`). + 2. Includes instructions for selecting specific tests, which tests are default, and specify python versions tested. +7. (Functionality/Packaging Guidelines) Repository is now linted via Actions + 1. Previously, relied on `pre-commit` alone. + 2. [New `lint.yml` workflow][lint workflow] just runs `pre-commit` to keep linting settings in `pyproject.toml`/`.pre-commit-config.yaml` + 3. Also, added `nox -s initialize_pre_commit`, automatically called by `nox -s devshell` and `nox -s devconda` to make it easier to set up the developer environment with `pre-commit`. This is still under testing. +8. (Documentation) Expanding on utility of `astrodata` in the README + 1. TKTODO + +## Issues +All issues raised as part of the initial review have been addressed: +
+ +Issues raised as part of this review + ++ Issue #18 ++ Issue #19 ++ Issue #22 ++ Issue #23 ++ Issue #25 ++ Issue #26 ++ Issue #27 ++ Issue #28 ++ Issue #29 ++ Issue #33 + +
+ +## Pull Requests + +All PRs have been merged into the main code: + +
+ +List of Pull Requests made as part of this review + ++ Pull Request #20 ++ Pull Request #21 + +
+ +Thank you for your contributions! + +## Other changes of note + +[devshells]: https://geminidrsoftware.github.io/astrodata/developer/index.html#install-the-dependencies +[poetry devs]: https://geminidrsoftware.github.io/astrodata/developer/index.html#install-the-dependencies +[test docs]: https://geminidrsoftware.github.io/astrodata/developer/index.html#run-the-tests + +1. We've moved from using `tox` for testing to `nox` for testing and general +automation. This was already planned for after this review to better support +`conda` testing, but it made more sense to get this done now. +2. The developer documentation has been overhauled to describe several new +development features motivated by these reviews: + 1. [Automated development environment creation][devshells] + 2. [Developing without a virtual environment][poetry devs] + 3. [Clearer testing documentation][test docs] + +## Responses to reviewer comments + +### mwcraig + +### aaryapatil