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.

Sign up for GitHub

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

Jump to bottom

STYLE replace flake8-rst with something maintained #46865

Open
MarcoGorelli opened this issue Apr 25, 2022 · 13 comments · May be fixed by #60654
Open

STYLE replace flake8-rst with something maintained #46865

MarcoGorelli opened this issue Apr 25, 2022 · 13 comments · May be fixed by #60654
Assignees
@stevenhastings
Labels
Code Style Code style, linting, code_checks good first issue

Comments

@MarcoGorelli
Copy link
Member

Currently, we use flake8-rst for running flake8 in code snippets in rst files:

pandas/.pre-commit-config.yaml

Lines 95 to 102 in 2e56a83

- id: flake8-rst
name: flake8-rst
description: Run flake8 on code snippets in docstrings or RST files
language: python
entry: flake8-rst
types: [rst]
args: [--filename=*.rst]
additional_dependencies: [flake8-rst==0.7.0, flake8==3.7.9]

However, flake8-rst isn't maintained, and is currently run in its own environment with a different flake8 version because of incompatibilities with flake8 v4

Task here is:

  • search around to see if there's a maintained tool which does the same thing (runs flake8 on code snippets in rst files)
  • try using that instead, fixup any new errors which may result from running it via pre-commit on all files
  • make a PR
@MarcoGorelli MarcoGorelli added Code Style Code style, linting, code_checks good first issue labels Apr 25, 2022
@KushalBeniwal
Copy link

Hi, I would like to work on this issue!

@MarcoGorelli
Copy link
Member Author

Go ahead, thanks

@KushalBeniwal KushalBeniwal mentioned this issue May 1, 2022
Closed
@KushalBeniwal
Copy link

I looked around but couldn't find any other maintained tool that solves our problem.

I did come across similar tools, like rstcheck, flakeheaven, but none of them solved our problem completely.

@MarcoGorelli
Copy link
Member Author

thanks for looking - OK, let's keep this one for now, might be worth forking it and maintaining it

@joshhayles
Copy link

@MarcoGorelli I'm a beginner who's learning backend development. Do you have any beginner-friendly issues I can contribute towards?

@stevenhastings
Copy link

take

@MarcoGorelli
Copy link
Member Author

wait @stevenhastings - apologies, I didn't get round to updating the issue

I recently managed to get in contact with the flake8-rst maintainer, and they've given me access to the repo - when I get a chance, I'll update the tool and make it compatible with the latest flake8

So I think this can be closed, apologies for having kept it open longer than necessary

@MarcoGorelli MarcoGorelli added this to the No action milestone Jul 18, 2022
@stevenhastings
Copy link

@MarcoGorelli no worries! thanks for letting me know.

@MarcoGorelli
Copy link
Member Author

reopening, as now we're removing flake8-rst as it's causing issue on python3.10, and nothing maintained seems to have come along

@MarcoGorelli MarcoGorelli reopened this Mar 8, 2023
@DeaMariaLeon DeaMariaLeon mentioned this issue Mar 8, 2023
Merged
5 tasks
@mroeschke mroeschke removed this from the No action milestone May 11, 2023
@rsm-23
Copy link
Contributor

rsm-23 commented Jul 1, 2023

@MarcoGorelli have you checked this project as an alternative?

@MarcoGorelli
Copy link
Member Author

i haven't, but if that does the same thing, then a pr would be very welcome!

@rsm-23
Copy link
Contributor

rsm-23 commented Jul 1, 2023

take

@rsm-23
Copy link
Contributor

rsm-23 commented Jul 1, 2023

I don' think the project I mentioned solves the issue. Un-assigning myself.

@rsm-23 rsm-23 removed their assignment Jul 1, 2023
@Revathyvenugopal162 Revathyvenugopal162 mentioned this issue Jul 15, 2023
Closed
5 tasks
@tqa236 tqa236 mentioned this issue Feb 13, 2024
Closed
5 tasks
ErfanShokrollahzadeh added a commit to ErfanShokrollahzadeh/pandas that referenced this issue Jan 3, 2025
@ErfanShokrollahzadeh
Replace flake8-rst with flake8-rst-docstrings
34829e4 
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).
@ErfanShokrollahzadeh ErfanShokrollahzadeh linked a pull request Jan 3, 2025 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@stevenhastings stevenhastings

Labels
Code Style Code style, linting, code_checks good first issue
Projects
None yet
Milestone
No milestone
6 participants
@mroeschke @joshhayles @MarcoGorelli @KushalBeniwal @stevenhastings @rsm-23