skpkg: Update project to latest scikit-package standards - #43
Conversation
|
@stevenhua0320 gentle ping : ) |
stevenhua0320
left a comment
stevenhua0320
left a comment
There was a problem hiding this comment.
Please see inline comments and make the edit, thanks!
|
|
||
| # General information about the project. | ||
| project = "diffpy.srxplanargui" | ||
| copyright = "%Y, The Trustees of Columbia University in the City of New York" |
There was a problem hiding this comment.
It should be the original license holders here.
There was a problem hiding this comment.
@stevenhua0320 This was also fixed in my push, not sure why it isnt autolabelled as outdated as well
| .. |title| replace:: diffpy.srxplanargui documentation | ||
|
|
||
| ``diffpy.srxplanargui`` - xPDFsuite, a software for PDF transformation and visualization. | ||
| ``diffpy.srxplanargui`` - GUI for diffpy.srxplanar |
There was a problem hiding this comment.
Change it to GUI for diffpy.srxplanar; subpart for xPDFsuite, a software...
There was a problem hiding this comment.
@stevenhua0320 What should I put after the three dots, or should I leave it as that?
There was a problem hiding this comment.
It is a software for PDF transformation and visualization
| "conda_pypi_package_dist_name": "diffpy.srxplanargui", | ||
| "package_dir_name": "diffpy.srxplanargui", | ||
| "project_short_description": "xPDFsuite, a software for PDF transformation and visualization.", | ||
| "project_short_description": "GUI for diffpy.srxplanar", |
There was a problem hiding this comment.
And same here, please add it is a subpart of xpdfsuite.
There was a problem hiding this comment.
@stevenhua0320 This line goes over 79 characters and since the file is a JSON I have no nice way to split it, should I work around the pre-commit somehow or is it okay if I leave this as the shorter version?
There was a problem hiding this comment.
Let's keep it as a shorter version here for now, but have some xpdfsuite info as possible.
|
@stevenhua0320 just pushed, let me know if everything looks fine now |
stevenhua0320
left a comment
stevenhua0320
left a comment
There was a problem hiding this comment.
Looks good to me now, @sbillinge ready to review.
sbillinge
left a comment
sbillinge
left a comment
There was a problem hiding this comment.
just one comment but it is an important one. If there is no gui code being tested, then please put a comment at that same place in the file so we don't revisit this question every time.
| with: | ||
| project: diffpy.srxplanargui | ||
| c_extension: false | ||
| headless: false |
There was a problem hiding this comment.
please check. If this has any gui code being tested it should be headless true.
There was a problem hiding this comment.
@sbillinge I just checked, no GUI code is being tested right now. I'll add a comment now and commit
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #43 +/- ##
=======================================
Coverage 50.00% 50.00%
=======================================
Files 2 2
Lines 18 18
=======================================
Hits 9 9
Misses 9 9
🚀 New features to boost your workflow:
|
3 participants
I ran the package update command to update everything to the latest sci-kit standards.
@stevenhua0320 ready to review