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

Address review comments from PyOpenSci #647

Open
wants to merge 15 commits into
base: develop
Choose a base branch
from

Conversation

MicahGale
Copy link
Collaborator

@MicahGale MicahGale commented Jan 28, 2025

Pull Request Checklist for MontePy

Description

This is the first PR for incorporating @munkm's comment as part of the PyOpenSci review.

This addresses the comments around documentation. #649 addresses the comments about the JOSS article.

@munkm could you review this?

Fixes #646


General Checklist

  • I have performed a self-review of my own code.
  • The code follows the standards outlined in the development documentation.
  • I have added tests that prove my fix is effective or that my feature works (if applicable).

Documentation Checklist

  • I have documented all added classes and methods.
  • For infrastructure updates, I have updated the developer's guide.
  • For significant new features, I have added a section to the getting started guide.

First-Time Contributor Checklist

  • If this is your first contribution, add yourself to pyproject.toml if you wish to do so.

Additional Notes for Reviewers

Ensure that:

  • The submitted code is consistent with the merge checklist outlined here.
  • The PR covers all relevant aspects according to the development guidelines.
  • 100% coverage of the patch is achieved, or justification for a variance is given.

📚 Documentation preview 📚: https://montepy--647.org.readthedocs.build/en/647/

@MicahGale MicahGale added documentation Improvements or additions to documentation PyOpenSci / JOSS labels Jan 28, 2025
@MicahGale MicahGale linked an issue Jan 28, 2025 that may be closed by this pull request
@tjlaboss
Copy link
Collaborator

Why does this trigger black? __init__.py isn't touched.

https://github.com/idaholab/MontePy/actions/runs/13032799103/job/36355785572?pr=647#step:5:12

@MicahGale
Copy link
Collaborator Author

It does for black 25.1 apparently. Maybe we need to start pinning black.

@MicahGale MicahGale added this to the joss milestone Feb 3, 2025
@MicahGale MicahGale requested a review from tjlaboss February 9, 2025 03:17
@MicahGale MicahGale self-assigned this Feb 9, 2025
@MicahGale MicahGale marked this pull request as ready for review February 9, 2025 03:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation PyOpenSci / JOSS
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Address review coments from @munkm
2 participants