python-trio / python-trio/flake8-async

Various minor things

Open
#310 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

documentation infrastructure rule improvement
Dominant language
Python
Stars
26
Forks
10
PR merge metrics
No merged PRs in 30d

Description

  1. I thought it was somewhat doomed to use ruff+flake8-async, but after way too long stumbled upon https://docs.astral.sh/ruff/settings/#lint_external We should probably suggest using this in docs.

  2. flake8 --per-file-ignores works with our 5-character error codes... for now. We should add a test to see when they get around to running validation on it and break compatibility in another way.

    • I also started looking at adding an --per-file-disable to get around it and for running as standalone, and it should be fairly doable
  3. should add an example on how to run flake8-async through flake8 in pre-commit.

  4. fix visitor102: https://github.com/python-trio/flake8-async/pull/307/files#diff-4852409e79e4eb0f3736b0d3c6b6bfd8c2a14411b92416bc203a387dd6986829

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Treat the four numbered items as separate work areas: Ruff's lint_external documentation, flake8 per-file-ignores compatibility testing, a pre-commit example, and visitor102 via pull request #307's diff. Start by reviewing the linked Ruff settings and PR diff, then locate the existing documentation and tests for each area. Done means each selected item has its corresponding documentation, compatibility test, example, or visitor102 fix.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, testing, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.