Skip to content

Enable ruff's flake8-implicit-str-concat (ISC) rules #2837

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

Merged
merged 7 commits into from
Dec 6, 2023
Merged

Conversation

seisman
Copy link
Member

@seisman seisman commented Nov 29, 2023

Description of proposed changes

Enable ISC rules.

Address #2741.

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
  • If adding new functionality, add an example to docstrings or tutorials.
  • Use underscores (not hyphens) in names of Python files and directories.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

  • /format: automatically format and lint the code
  • /test-gmt-dev: run full tests on the latest GMT development version

@seisman seisman added the maintenance Boring but important stuff for the core devs label Nov 29, 2023
@seisman seisman added this to the 0.11.0 milestone Nov 29, 2023
@seisman seisman added the needs review This PR has higher priority and needs review. label Nov 29, 2023
@seisman seisman requested a review from a team December 4, 2023 16:33
Copy link
Member

@yvonnefroehlich yvonnefroehlich left a comment

Choose a reason for hiding this comment

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

Sofar I did not follow the PRs related to issue #2741 in greater detail. So, maybe I am missing some context here, but I am wondering why the ISC rule is not added to the list in pyproject.toml in contrast to the other ruff rules:

pygmt/pyproject.toml

Lines 100 to 112 in 78dfcf1

[tool.ruff.lint]
select = [
"B", # flake8-bugbear
"E", # pycodestyle
"F", # pyflakes
"I", # isort
"NPY", # numpy
"PD", # pandas-vet
"PL", # pylint
"SIM", # flake8-simplify
"UP", # pyupgrade
"W", # pycodestyle warnings
]

```
warning: The following rules may cause conflicts when used with the formatter: `ISC001`.
To avoid unexpected behavior, we recommend disabling these rules, either by removing them
from the `select` or `extend-select` configuration, or adding them to the `ignore` configuration.
```
@seisman
Copy link
Member Author

seisman commented Dec 5, 2023

Sofar I did not follow the PRs related to issue #2741 in greater detail. So, maybe I am missing some context here, but I am wondering why the ISC rule is not added to the list in pyproject.toml in contrast to the other ruff rules:

pygmt/pyproject.toml

Lines 100 to 112 in 78dfcf1

[tool.ruff.lint]
select = [
"B", # flake8-bugbear
"E", # pycodestyle
"F", # pyflakes
"I", # isort
"NPY", # numpy
"PD", # pandas-vet
"PL", # pylint
"SIM", # flake8-simplify
"UP", # pyupgrade
"W", # pycodestyle warnings
]

Thanks for catching it. I forgot to add it. Now added in 0d78ee5

Co-authored-by: Michael Grund <[email protected]>
@seisman seisman added final review call This PR requires final review and approval from a second reviewer and removed needs review This PR has higher priority and needs review. final review call This PR requires final review and approval from a second reviewer labels Dec 5, 2023
@seisman seisman merged commit 774a7b8 into main Dec 6, 2023
@seisman seisman deleted the ruff/ISC branch December 6, 2023 02:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Boring but important stuff for the core devs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants