Skip to content

docs: use src layout paths in contributor commands - #3532

Closed
raghav-sharma-ai wants to merge 1 commit into
python-trio:mainfrom
raghav-sharma-ai:patch-1
Closed

raghav-sharma-ai wants to merge 1 commit into
python-trio:mainfrom
raghav-sharma-ai:patch-1

Conversation

@raghav-sharma-ai

Copy link
Copy Markdown

The contributor guide still points its Black and slow-test examples at a top-level trio directory. The package now lives at src/trio, so copying those commands from the repository root fails before checking any files. Update the three commands and the accompanying package-path wording.

Validation:

  • The original Black command fails with Path 'trio' does not exist.
  • black --check --diff --workers 1 src/trio succeeds (143 files unchanged).
  • sphinx-lint docs/source/contributing.rst and git diff --check pass.

Documentation-only change; the full slow-test suite was not run. Prepared with AI assistance (OpenAI Codex).

Update Black and slow-test examples to target src/trio, matching the current repository layout.

Prepared with AI assistance (OpenAI Codex).
@A5rocks

A5rocks commented Oct 5, 2026 •

Copy link
Copy Markdown
Contributor

CI failing isn't due to this change. However, I think in general we should rewrite the contributor docs, to e.g. point at pre-commit instead of black, and I don't think we need the package to pytest? Probably and other stuff.

But I'd like the contributor documentation not to be LLM generated (that would just be rude!), so maybe someone else can do this!

@A5rocks A5rocks closed this Oct 5, 2026
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.

2 participants