Skip to content

Some more doc in python exception#627

Merged
atztogo merged 6 commits intospglib:developfrom
atztogo:pyspglib-exception-doc
Dec 24, 2025
Merged

Some more doc in python exception#627
atztogo merged 6 commits intospglib:developfrom
atztogo:pyspglib-exception-doc

Conversation

@atztogo
Copy link
Copy Markdown
Collaborator

@atztogo atztogo commented Dec 22, 2025

How about this?

Fix #624

@atztogo atztogo requested a review from LecrisUT December 22, 2025 06:45
@codecov
Copy link
Copy Markdown

codecov bot commented Dec 22, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 74.05%. Comparing base (e02be02) to head (717cf5e).
⚠️ Report is 10 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #627   +/-   ##
========================================
  Coverage    74.05%   74.05%           
========================================
  Files           27       27           
  Lines         8018     8018           
  Branches      1646     1643    -3     
========================================
  Hits          5938     5938           
  Misses        1603     1603           
  Partials       477      477           
Flag Coverage Δ
c_api 69.45% <ø> (ø)
fortran_api 52.96% <ø> (ø)
python_api 67.18% <ø> (ø)
unit_tests 11.68% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@LecrisUT LecrisUT requested a review from lan496 December 23, 2025 14:15
@LecrisUT LecrisUT force-pushed the pyspglib-exception-doc branch from 474a264 to bfa1c89 Compare December 23, 2025 14:26
Copy link
Copy Markdown
Member

@lan496 lan496 left a comment

Choose a reason for hiding this comment

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

LGTM

@atztogo atztogo merged commit 84693ee into spglib:develop Dec 24, 2025
50 checks passed
@atztogo
Copy link
Copy Markdown
Collaborator Author

atztogo commented Dec 24, 2025

Ok, updated the documentation with some of the hints you suggested. Also proposing to release 2.8.0 where we switch the default relatively quick so the users would not have to wait to opt-in the exception feature. They could just lock the dependency at 2.7 if they cannot update quickly. But for now having it a bit noisy should help with the visibility that they need to update these, and we can make 2.7.1 release silencing the warning if needed.

Thanks @LecrisUT!

@atztogo atztogo deleted the pyspglib-exception-doc branch December 28, 2025 09:41
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.

Documentation for OLD_ERROR_HANDLING

3 participants