Part 2/3 of Cookiecutter pre-commit workflow (flake8)

[bobleesj]

As instructed in #53 (review), here, I created a branch called flake8 from the upstream cookie branch.

Changed:

• Fixed line-width of 115 error (E501)
• Removed unused imports of functions and packages
• CI passes (https://github.com/bobleesj/diffpy.snmf/actions/runs/10208965578)

Just to confirm my workflow:

# Add upstream
git remote add upstream https://github.com/diffpy/diffpy.snmf

# Fetch all branches and updates from the upstream repository
git fetch upstream 

# Creates a local branch named cookie that tracks upstream/cookie
git checkout -b cookie upstream/cookie

# Ensure the latest updates
git pull

# Make a local branch from cookie
git checkout -b flake8

[sbillinge]

great work, please see inline comment.

[sbillinge]

remove this comment. Less chatter is better in the future, though I appreciate you wanting to communicate with me what you are doing (I think I can figure it out though.

For these lambda flake8 errors we would normally see if the function is being used in more than one place, and if it is, define a private function somewhere outside the main part of the code. If it is only being used in one place, we would simply move the lambda to where it is being used (so not assign it to a variable and then put the variable where it is being used, or we could put a # noqa: E731 at the end of this line so we leave it as is but it won't fail flake8.

How do we decide? the objective of all of this is not to pass flake8 but to make the code better, so the choice we make is the one that will make the code the best.

Also, in general, don't leave commented code in there, just delete it. Again, I appreciate the impulse (more transparency) but we don't want to carry around every old version of code in hte future.

[bobleesj]

Thank you. A new pull request addressing your feedback has been made: #56

[sbillinge]

As instructed in #53 (review), here, I created a branch called flake8 from the upstream cookie branch.

Changed:

* Fixed line-width of 115 error (E501)

* Removed unused imports of functions and packages

* CI passes (https://github.com/bobleesj/diffpy.snmf/actions/runs/10208965578)

Just to confirm my workflow:

# Add upstream
git remote add upstream https://github.com/diffpy/diffpy.snmf

# Fetch all branches and updates from the upstream repository
git fetch upstream 

# Creates a local branch named cookie that tracks upstream/cookie
git checkout -b cookie upstream/cookie

# Ensure the latest updates
git pull

# Make a local branch from cookie
git checkout -b flake8

this workflow is spot on. I think you know, but just to say, you only have to connect to upstream and fetch once-and-done. Once you fetch, you should be able to just git checkout cookie and it should already be set to track upstream/cookie, but doing it your way is more explicit. Again, this is once and done, once you set cookie to track upstream/cookie, afte rthat you just need to do git pull to sync . Nice work.

[bobleesj]

git checkout cookie

-> Switched to branch 'cookie'
-> Your branch is up to date with 'upstream/cookie'.

Once-and-done, confirmed! @sbillinge