STYLE replace flake8-rst with something maintained

[MarcoGorelli]

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

[KushalBeniwal]

Hi, I would like to work on this issue!

[MarcoGorelli]

Go ahead, thanks

[KushalBeniwal]

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]

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

[joshhayles]

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

[stevenhastings]

take

[MarcoGorelli]

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

[stevenhastings]

@MarcoGorelli no worries! thanks for letting me know.

[MarcoGorelli]

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

[rsm-23]

@MarcoGorelli have you checked this project as an alternative?

[MarcoGorelli]

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

[rsm-23]

take

[rsm-23]

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