chore: fixed all namings to follow conventions

[TingwenZhang]

Fix all files to follow the naming convention at https://scikit-package.github.io/scikit-package/billinge-group-standards.html#naming-conventions.

[cadenmyers13]

@TingwenZhang Please see inline comments. Looks like everything is passing, but just needs approval from @sbillinge ?

[sbillinge]

Thanks, this looks great. I expect the image files are used in documentation, so please build docs and make sure that there are no broken links. On thing to do is a global search for the old filename.

If you can confirm no broken links I can merge.

[sbillinge]

please undo this change. we need the @v0

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.10%. Comparing base (c5fa048) to head (461e94d).
Report is 6 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #279   +/-   ##
=======================================
  Coverage   95.10%   95.10%           
=======================================
  Files          23       23           
  Lines        1123     1123           
=======================================
  Hits         1068     1068           
  Misses         55       55           

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[sbillinge]

Thanks @TingwenZhang when you confirm that all the links to images are working in the built documentation I can merge. Do you know how to build the documentation? @bobleesj can give some guidance on that. It gives most confidence when there are one or two examples of screen-shots copy-pasted and a comment to say you checked them all.

There is no need to change your last commit message, it is good, except that would be a fix not a chore.

Nice work. We are being picky because we want to make use of the learning opportunity.

[TingwenZhang]

@sbillinge
I double checked all subdirectories under /doc and none of the images in the documentation (user guide or online documentation) are affected by my changes. The changes I made was only under /src/diffpy/pdfgui/icons.

The old image names (images with _ ) do not exist anywhere in this repository.
The new image names (images with -) only exist in aboutdialog.py, which have been modified in 461e94d.

All the links in the documentation are still working.

[sbillinge]

I think these logos are used in the actual PDFgui code in that case. Do they render correctly when you run PDFgui after installing it in editable mode?

[TingwenZhang]

Yes, since the files only are used in aboutdialog.py.

[sbillinge]

@TingwenZhang thanks so much for this! Nice job.

[sbillinge]

@TingwenZhang would it be possible for you to take a few of the other projects and do the same job? We can also give this to other people to help them learn the workflow, but it is good to reinforce things if you do one or two more. Hopefully you are getting the hang of the importance of clear communication in the comments etc. and this will start to come naturally with fewer iterations.

[bobleesj]

documentation? @bobleesj can give some guidance on that.

@TingwenZhang There is a section in the Level 5 tutorial on "building documentation locally"

It is very nice. Great work!

[TingwenZhang]

Sure, I can take another issue. I find fixing issues to be very helpful with learning the pull-request workflow.

I just realized I was assigned to diffpy/diffpy.snmf#145, but the issue I fixed was #277. I can take issue 145.

[sbillinge]

@TingwenZhang sounds good.

We are about to release a new scikit-package, at which point all our projects will need to be repackaged. I think in most cases these -, _ issues can be fixed at the same time. Do you agree @bobleesj ?

@bobleesj I know you ran a script to auto-generate all those issues. Does that script also create some kind of mission-control comment by any chance with check-boxes so we can keep track of who is doing what where?

[bobleesj]

@bobleesj I know you ran a script to auto-generate all those issues. Does that script also create some kind of mission-control comment by any chance with check-boxes so we can keep track of who is doing what where?

It's a very simple script... just writing GH issues only. I shared with @cadenmyers13 a few days ago and also demoed to him. But a simple way to track progress I have done in the past was looking at the referenced remaining issues in the PR like in scikit-package/scikit-package#330

I think in most cases these -, _ issues can be fixed at the same time. Do you agree @bobleesj ?

I agree. I can volunteer to do a couple of them and test the experience of migrating files on our skpkg doc. Perhaps we could have a quick example section (in our doc) on "how to migrate an already standardized section" for new group members (it can be used as a pedagogical one).

[sbillinge]

It's a very simple script... just writing GH issues only. I shared with @cadenmyers13 a few days ago and also demoed to him. But a simple way to track progress I have done in the past was looking at the referenced remaining issues in the PR like in scikit-package/scikit-package#330

yah, that is good enough. Just to figure out the remaining open issues is all we need. It is hard when each one is on a different repo otherwise.