Skip to content

skpkg: Update prokect to latest scikit-package standards - #49

Merged
sbillinge merged 4 commits into
diffpy:mainfrom
danielsirakov:scikit-package-update
Sep 9, 2026
Merged

sbillinge merged 4 commits into
diffpy:mainfrom
danielsirakov:scikit-package-update

Conversation

@danielsirakov

Copy link
Copy Markdown
Contributor

I ran sci-kit package update. I'm about to commit another update since I had some issues with which version of the files git was tracking so I went back in to reupdate things manually.

@danielsirakov

Copy link
Copy Markdown
Contributor Author

@stevenhua0320 This should be ready now, let me know if anything looks wrong. Thanks!

Comment thread docs/source/index.rst
Authors
=======

``diffpy.srxplanar`` is developed by Xiaohao Yang and Billinge Group members. The maintainer for this project is Simon Billinge. For a detailed list of contributors see

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We would like to keep the original authors here.

Comment thread README.rst Outdated
:target: https://github.com/psf/black

.. |CI| image:: https://github.com/diffpy/diffpy.cmi/actions/workflows/matrix-and-codecov-on-merge-to-main.yml/badge.svg
.. |CI| image:: https://github.com/diffpy/diffpy.srxplanar/actions/workflows/matrix-and-codecov-on-merge-to-main.yml/badge.svg

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We need to edit the directed yaml to matrix-and-codecov.yml

@stevenhua0320 stevenhua0320 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Everything else looks good to me, please make the last edits and we could let prof. Simon to review.

@danielsirakov

Copy link
Copy Markdown
Contributor Author

@stevenhua0320 Got it, just made the edits.

@stevenhua0320

Copy link
Copy Markdown
Contributor

Looks good to me now @sbillinge ready to review.

@codecov

codecov Bot commented Sep 7, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (254051e) to head (4c1e3b4).

Additional details and impacted files
@@            Coverage Diff            @@
##              main       #49   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            3         3           
  Lines           48        48           
=========================================
  Hits            48        48           
Files with missing lines Coverage Δ
tests/conftest.py 100.00% <100.00%> (ø)
tests/test_version.py 100.00% <100.00%> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@sbillinge sbillinge left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

looks good. Just a few small fixes needed. Please see inline comments

Comment thread docs/source/conf.py Outdated
Comment thread news/scikit-package-update.rst Outdated
Comment thread src/diffpy/srxplanar/__init__.py Outdated
Comment thread src/diffpy/srxplanar/version.py Outdated
Comment thread src/diffpy/__init__.py
Comment thread src/diffpy/__init__.py
Comment thread AUTHORS.rst Outdated
@danielsirakov

Copy link
Copy Markdown
Contributor Author

@sbillinge @stevenhua0320 Sorry for the delay, I just now saw your messages. I pushed the changes, let me know if there's anything else I should add or fix.

@sbillinge

Copy link
Copy Markdown
Contributor

@sbillinge @stevenhua0320 Sorry for the delay, I just now saw your messages. I pushed the changes, let me know if there's anything else I should add or fix.

@danielsirakov please set up notifications so you see these. The PR workflow often just needs a response that takes a few minutes of your time and can fit into cracks in your day, but because of its iterative nature, if you don't see it and don't respond a simple task can extend the project by weeks. On our side we try and respond quickly (within a day) and expect to get pinged if you are waiting longer than that.

@sbillinge sbillinge left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

please see comments inline.

  1. you missed one of the author fixes
  2. comment about setting up notifications and responding quickly
  3. comment about always responding to every comment, even if it is a just one-word response. It tells us you saw it and what your thought is about it.

Comment thread cookiecutter.json
"maintainer_names": "Simon Billinge",
"maintainer_emails": "sbillinge@ucsb.edu",
"maintainer_github_usernames": "sbillinge",
"contributors": "Billinge Group Members",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

THis should be the original

@danielsirakov danielsirakov Sep 8, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@sbillinge The original doesn't have Xiaohao Yang as an author, should I add him and his e-mail?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

yes, if possible. Good catch

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@sbillinge do you know what Xiaohao's e-mail is? I can't find it in the repository or on his github profile

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@sbillinge just following up, do you know where I could find Xiaohao's e-mail?

Comment thread cookiecutter.json
@danielsirakov

Copy link
Copy Markdown
Contributor Author

File coded by: Xiaohao Yang and Billinge Group members.

I have e-mail notifications on so I usually get notified right away, I'm not sure why I didn't get a push for this one. I just now also installed the GitHub app on my phone to be extra sure I get notified in the future. Sorry about the delay this caused, I won't let this happen again.

@sbillinge
sbillinge merged commit 45dc5fa into diffpy:main Sep 9, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants