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

Reduce flake8 max-line-length. #3133

Closed
wants to merge 7 commits into from
Closed

Reduce flake8 max-line-length. #3133

wants to merge 7 commits into from

Conversation

Olotuah
Copy link

@Olotuah Olotuah commented Mar 5, 2024

Description

This pull request reduces the Flake8 max-line-length in the process_worker_pool.py file to improve code readability and maintainability. It addresses the Flake8 error reported on line 872 of process_worker_pool.py by splitting a long line of code into multiple shorter lines.

Changed Behaviour

After this PR, the maximum line length in the process_worker_pool.py file will be reduced, and the code will adhere to the Flake8 style guide, which recommends a maximum line length of 79 characters for improved readability.

Fixes

Fixes #3126

Type of change

Choose which options apply, and delete the ones which do not apply.

  • Code maintenance/cleanup

@Olotuah
Copy link
Author

Olotuah commented Mar 5, 2024

@benclifford Is there anything I should take note of next time?

.flake8 Outdated
max-line-length = 152
max-line-length = 153
Copy link
Collaborator

Choose a reason for hiding this comment

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

Hmm; this number has gotten bigger, not smaller. Per the ticket, I'm positive you correctly reduced the value initially ... so what happened and when? What do you need to do now?

Copy link
Author

Choose a reason for hiding this comment

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

It was modified from 154 to 153, then i pushed to the repo and initiated a pull request but got a conflict. So I think the conflict was triggered by duplicates line of code along with the conflict markers, so i just deleted one line and the markers because you need to decide which version of the max-line-length setting you want to keep. Since both versions are adjacent and come from the same branch (master), you can simply choose one of them.

Copy link
Collaborator

Choose a reason for hiding this comment

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

*nod; I understand. I'm asking you to think critically. What is the point of the ticket? And, more precisely, what is the specific instruction?

When that is clear, what needs to happen here? I understand the steps you've taken, but now what would otherwise be merged is not accurate to the ticket.

Copy link
Author

Choose a reason for hiding this comment

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

Making the line length smaller, then I will test and validate. I will update my pull request. What do you think please?

Copy link
Author

Choose a reason for hiding this comment

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

Hi @khk-globus,

I wanted to inform you that I have committed and pushed the latest changes to my repository.

Please review the updates at your convenience, and please let me know if you have any feedback or questions.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Thank you; FWIW ("for what it's worth"), you don't need to explicitly tell me this type of detail. When one enters a PR conversation (e.g., making the PR, commenting on the PR), GitHub will email them thereafter.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Please review the updates at your convenience, and please let me know if you have any feedback or questions.

Now the hunk to change the line-length is missing entirely. Again, what is the point of the ticket? What is the specific task for the PR?

Copy link
Author

Choose a reason for hiding this comment

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

@khk-globus Please what do you suggest I do.

Copy link
Collaborator

Choose a reason for hiding this comment

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

*nod; I understand. I'm asking you to think critically. What is the point of the ticket? And, more precisely, what is the specific instruction?

@khk-globus Please what do you suggest I do.

This is the "think critically" part. I know what I might do, but that's not important. This is your pull request, not mine. A couple of thoughts come to mind:

Do you see a discrepancy?

Copy link
Author

Choose a reason for hiding this comment

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

Thank you @khk-globus, This shows that my PR isnt Aligned with the goals of the Issue #3105

@Olotuah Olotuah closed this Mar 6, 2024
Copy link
Collaborator

@khk-globus khk-globus left a comment

Choose a reason for hiding this comment

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

In general, PRs should remain focused on one logical change.[1] The title of this PR is "Reduce flake8 max-line-length" — a good, focused change.

As of the recent merge, this PR now has some unrelated changes, currently:

  • changelog.rst
  • design.rst
  • index.rst

As I was typing index.rst, I see that the ticket closed, so I suspect you saw that detail. I'm guessing at what happened, so let me draw your attention to GitHub's text near the top of the ticket:

Olotuah wants to merge 7 commits into Parsl:master from Olotuah:master

In slightly different language, that states that if this PR is merged, Parsl's master will take in the changes from Olotuah's master branch.

Does that give you a hint as to how to approach having multiple PRs open at the same time? Or how to update your master branch without affecting your open PRs?

[1] For now, I simply make this statement, but I may ask in a follow up why PRs should remain focused on a single logical change.

@Olotuah
Copy link
Author

Olotuah commented Mar 6, 2024

@khk-globus It was a mistake from my end, I saved the message as "Add Historical Documents section and update index" but my branch got merge and i saw the commit message had change , i immediately closed it when i noticed.

I have to Regularly fetch the changes from the upstream repo to my branch so its updated and can I always create a new branch for each PRs?

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.

2 participants