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

style: cookiecutter and pre-commit formatting updates #77

Merged
merged 12 commits into from
Jan 7, 2025

Conversation

cadenmyers13
Copy link
Contributor

Also updated copyright from 2024 to 2025. Did not add a news item because code functionality does not change.

.gitignore Show resolved Hide resolved
.isort.cfg Show resolved Hide resolved
src/diffpy/fourigui/fourigui.py Show resolved Hide resolved
src/diffpy/fourigui/fourigui.py Outdated Show resolved Hide resolved
Copy link

codecov bot commented Jan 7, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.78%. Comparing base (1521c33) to head (9216a29).
Report is 13 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #77   +/-   ##
=======================================
  Coverage   93.78%   93.78%           
=======================================
  Files           4        4           
  Lines         177      177           
=======================================
  Hits          166      166           
  Misses         11       11           
Files with missing lines Coverage Δ
tests/integration_test.py 98.03% <100.00%> (ø)
tests/test_fourigui.py 99.07% <100.00%> (ø)

Copy link
Contributor

@sbillinge sbillinge left a comment

Choose a reason for hiding this comment

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

Please see inline comments. For copyright statements, give them the correct range as best as you can figure it out. Code written by Sani was with when he was here which was around when he published his paper (a bit before)

LICENSE.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
doc/source/conf.py Show resolved Hide resolved
doc/source/conf.py Show resolved Hide resolved
doc/source/license.rst Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
src/diffpy/__init__.py Outdated Show resolved Hide resolved
src/diffpy/fourigui/fourigui.py Show resolved Hide resolved
src/diffpy/fourigui/fourigui.py Outdated Show resolved Hide resolved
@sbillinge
Copy link
Contributor

Please see new way of handling news to her everything passing

Copy link
Contributor

@sbillinge sbillinge left a comment

Choose a reason for hiding this comment

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

Could of small things. Also, a bunch of the copyrights seen to have disappeared. Please check any file you edited is updated to <original date> - 2025

@cadenmyers13
Copy link
Contributor Author

@bobleesj Can we add functionality to better handle copyright in scikit-package? Whenever the cookiecutter is ran, it overwrites the previous, accurate copyright which forces you to go back in and change things manually.

When we run scikit, we could add a user input response that says "Year of first release:". If its before the current year, then the copyright would update with a hyphen (ie. Copyright 2022-2025). If its a new package or was published within the current year, that could be the default response (ie. Copyright 2025). We would have to be thoughtful not to have unnecessary hyphens, but I think this would streamline things a bit. Thoughts?

@cadenmyers13
Copy link
Contributor Author

Could of small things. Also, a bunch of the copyrights seen to have disappeared. Please check any file you edited is updated to <original date> - 2025

Okay, the copyrights should be good now. Let me know if things look off on your end.

@bobleesj
Copy link
Contributor

bobleesj commented Jan 7, 2025

Maybe. But I dont see a big benefit because one could simply run git diff and run git restore . This doesn't require that many files to review and we want users to do this actuall.

Second, some packages and within ours have likely have different license formats and we dont want to force non diffpy users to enter this year info

@sbillinge
Copy link
Contributor

Maybe. But I dont see a big benefit because one could simply run git diff and run git restore . This doesn't require that many files to review and we want users to do this actuall.

Second, some packages and within ours have likely have different license formats and we dont want to force non diffpy users to enter this year info

Yes, this is correct. It is only relevant for the package update modality and then the file header info could be anything.

On the other hand, if we are using a standard file header in our package create, we could do an update that assumes this format and does nothing if there is no pattern match?

@sbillinge sbillinge merged commit c17c8e3 into diffpy:main Jan 7, 2025
5 checks passed
@cadenmyers13 cadenmyers13 deleted the cookiecutv2 branch January 9, 2025 16:55
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