search

epiverse-trace / simulist

An R package for simulating line lists
https://epiverse-trace.github.io/simulist/
Other
4 stars 0 forks source link

{simulist} v0.3.0 full package review #117

Closed joshwlambert closed 1 month ago

joshwlambert commented 1 month ago

This PR is to provide a platform to review the entirety of the package.

Once this review concludes I will release v0.3.0 on GitHub.

Please see the NEWS.md file for an overview of changes between v0.2.0 and v0.3.0.

This PR is unconventional as it is not intended for merging or for additional commits (unless minor) and instead comments will be converted to issues and these will be addressed in their own PRs.

github-actions[bot] commented 1 month ago

This pull request:

(Note that results may be inacurrate if you branched from an outdated version of the target branch.)

github-actions[bot] commented 1 month ago

This pull request:

Reach out on slack (#code-review or #help channels) to double check if there are base R alternatives to the new dependencies.

(Note that results may be inaccurate if you branched from an outdated version of the target branch.)

joshwlambert commented 1 month ago

When I originally opened this PR the review branch was many commits behind main and I did not notice (I think this was because I previously had a review branch for the last full package review (#73) and the branch did not update even though I deleted it previously). I've now fixed this by rebasing review onto main and now this PR contains all the changes up to the HEAD of main. Apologies if this has caused any inconvenience.

joshwlambert commented 1 month ago

A big thank you to both reviewers for providing many helpful comments and suggestions. As always these reviews have improved the package.

Most comments have been responded to, linking to commit hashes or PRs that implement the change. Some changes that require more time and thought have been logged as issues and will be tackled in development for the next version. Some comments are left unresolved so that anyone can chip in and share their opinions.

I will now close this full package review PR and move on to the release checklist and release v0.3.0. 🚀

Thanks again for the speedy and enjoyable review! 😄