FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

V3.7.0 by cadenmyers13 · Pull Request #377 · diffpy/diffpy.utils · GitHub

  1. diffpy
  2. diffpy.utils

Repository navigation

V3.7.0 - #377

Merged
sbillinge merged 20 commits into
diffpy:mainfrom
cadenmyers13:import-bug
Feb 4, 2026
ConversationCommits (20)ChecksFiles changed
Merged

V3.7.0#377
sbillinge merged 20 commits into
diffpy:mainfrom
cadenmyers13:import-bug

Conversation

cadenmyers13 commented Feb 3, 2026 •
edited by sbillinge
Loading

Copy link
Copy Markdown
Contributor

closes #376

sbillinge and others added 11 commits January 17, 2026 13:50
cadenmyers13 mentioned this pull request Feb 3, 2026
Closed

codecov Bot commented Feb 3, 2026 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (3f9ae8e) to head (efd094d).
⚠️ Report is 22 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff            @@
##              main      #377   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            9        10    +1     
  Lines          516       567   +51     
=========================================
+ Hits           516       567   +51
Files with missing lines Coverage Δ
tests/test_deprecator.py 100.00% <100.00%> (ø)
tests/test_loaddata.py 100.00% <100.00%> (ø)
tests/test_serialization.py 100.00% <100.00%> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

cadenmyers13 commented Feb 3, 2026

Copy link
Copy Markdown
Contributor Author

@sbillinge ready for review/merge. I also added a light tests for the deprecator just to be thorough

sbillinge reviewed Feb 3, 2026
View reviewed changes

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

please see comments

Comment thread src/diffpy/utils/_deprecator.py
)


def generate_deprecation_docstring(new_name, removal_version, new_base=None):

sbillinge Feb 3, 2026

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

why did you remove this?

cadenmyers13 Feb 3, 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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

It isnt used anywhere. my idea with it was to have it as a helper that could easily print the docstring then the user could copy/paste the docstring where it needs to go. I removed it because I felt like this was overkill but if you think its helpful we can add it back

sbillinge Feb 4, 2026

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I wrote it because I was hoping for more uniformity. You could just print the docstring template and use it.

cadenmyers13 Feb 4, 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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

@sbillinge oh whoops thought i wrote it 😂 . I'll add it back and make it more clear that this is for printing your docstring message.

Comment thread src/diffpy/utils/_deprecator.py Outdated


def build_deprecation_message(
def deprecation_message(

sbillinge Feb 3, 2026

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

don't we want our function names to be verbs not nouns? I think I prefer build_deprecation_message?

cadenmyers13 Feb 3, 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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

@sbillinge Okay we can change this

cadenmyers13 commented Feb 3, 2026

Copy link
Copy Markdown
Contributor Author

@sbillinge ready for review again

sbillinge commented Feb 4, 2026

Copy link
Copy Markdown
Contributor

@cadenmyers13 ok, I left a comment. Everything else looks fine. Thanks for getting the verb-name function going.

cadenmyers13 commented Feb 4, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

@sbillinge because printing the docstring manually will be quite annoying i added a little cli tool that helps print it.

Once approve, please merge this PR in scikit-package instructions: scikit-package/scikit-package#655

Update news for Python 3.14 support and changes
106b419 
Added command line interface for generating template docstring for deprecated functions and updated references for loadData.

sbillinge commented Feb 4, 2026

Copy link
Copy Markdown
Contributor

I updated the news to better reflect what is in here and will merge.

Please could you make an issue on scikit-package to move the cli for the deprecation message to there (and remove it from here), which is a better place for it. We could also add instructions to the deprecation part of the docs and have it running is skpkg rather than here. We could leave the code here or move it over, I don't mind, but the cli makes more sense over there

cadenmyers13 mentioned this pull request Feb 4, 2026
Closed

cadenmyers13 commented Feb 4, 2026

Copy link
Copy Markdown
Contributor Author

@sbillinge I created the issue. Lets leave the generator code here so deprecation stuff is in one place. I made an edit to one of the docstrings while you edited the news so i got a merge conflict (hints the merge commit). Anyways, this should be good now

cadenmyers13 commented Feb 4, 2026
View reviewed changes
Comment thread news/deprecator.rst
@@ -1,6 +1,5 @@
**Added:**

* added a function in _deprecator to generate a deprecation message for copy pasting

cadenmyers13 Feb 4, 2026 •
edited
Loading

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

moved to different news dep-msg-helper.rst with more description

sbillinge merged commit a6ddd06 into diffpy:main Feb 4, 2026
7 checks passed
cadenmyers13 deleted the import-bug branch February 4, 2026 18:49
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

sbillinge sbillinge left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

Back | FazBrowse Home | New Git URL