Skip to content

docs: add test readability guidance#684

Open
kernelpanic888 wants to merge 1 commit into
pyOpenSci:mainfrom
kernelpanic888:task24-c08-test-readability-20260706
Open

docs: add test readability guidance#684
kernelpanic888 wants to merge 1 commit into
pyOpenSci:mainfrom
kernelpanic888:task24-c08-test-readability-20260706

Conversation

@kernelpanic888

@kernelpanic888 kernelpanic888 commented Jul 6, 2026

Copy link
Copy Markdown

Summary

  • Add a short section on writing tests that are easy for reviewers and contributors to read.
  • Place it after the existing test_add_numbers example in tests/write-tests.md.
  • Include maintained testing references for pytest and Python's unittest docs.

Checks

  • git diff --check
  • .venv/bin/sphinx-build -W --keep-going -b html . _build/html -D language=en

Closes #509

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: europython-2026

Development

Successfully merging this pull request may close these issues.

Enhance the Tests section with best practices for clarity and documentation

3 participants