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

Replace flake8-rst with flake8-rst-docstrings #60654

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

ErfanShokrollahzadeh
Copy link

@ErfanShokrollahzadeh ErfanShokrollahzadeh commented Jan 3, 2025

Fixes #46865

Replace flake8-rst with flake8-rst-docstrings for running flake8 on code snippets in rst files.

  • pyproject.toml

    • Remove flake8 from the tool.ruff.lint section.
    • Add flake8-rst-docstrings to the tool.ruff.lint section.
    • Update the tool.ruff.lint section to use flake8-rst-docstrings instead of flake8-rst.
  • .pre-commit-config.yaml

    • Remove the flake8-rst hook from the hooks section.
    • Add a new hook for flake8-rst-docstrings in the hooks section.
    • Configure the new flake8-rst-docstrings hook with appropriate additional_dependencies.

For more details, open the Copilot Workspace session.

Fixes pandas-dev#46865

Replace `flake8-rst` with `flake8-rst-docstrings` for running flake8 on code snippets in rst files.

* **pyproject.toml**
  - Remove `flake8` from the `tool.ruff.lint` section.
  - Add `flake8-rst-docstrings` to the `tool.ruff.lint` section.
  - Update the `tool.ruff.lint` section to use `flake8-rst-docstrings` instead of `flake8-rst`.

* **.pre-commit-config.yaml**
  - Remove the `flake8-rst` hook from the `hooks` section.
  - Add a new hook for `flake8-rst-docstrings` in the `hooks` section.
  - Configure the new `flake8-rst-docstrings` hook with appropriate `additional_dependencies`.

---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/pandas-dev/pandas/issues/46865?shareId=XXXX-XXXX-XXXX-XXXX).
.pre-commit-config.yaml Outdated Show resolved Hide resolved
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.

STYLE replace flake8-rst with something maintained
2 participants