Skip to content

docs: clarify installation instructions and notes#11

Merged
Pymetheus merged 1 commit intomainfrom
develop
Feb 4, 2026
Merged

docs: clarify installation instructions and notes#11
Pymetheus merged 1 commit intomainfrom
develop

Conversation

@Pymetheus
Copy link
Owner

Description

Update README and checklist to improve wording and installation guidance: change “Strict static typing” to “Strict static type checking” (mypy), add a link to the example project, and expand the Install & Run section to show alternative package manager commands (pip install -e ".[dev]", uv sync --extra dev, poetry install --extras dev). Also tidy a note's punctuation and update docs/CHECKLIST to use uv sync --extra dev.

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Code refactoring
  • Performance improvement
  • Test addition or update

Related Issue

no issue

Changes Made

  • Update README and checklist to improve wording and installation guidance

Testing

Describe how you tested your changes:

  • Unit tests pass
  • Integration tests pass
  • Manual testing performed

Screenshots (if applicable)

Add screenshots to help explain your changes.

Checklist

  • My code follows the project's style guidelines
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have updated the documentation accordingly
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Additional Context

Add any other context about the PR here.

Update README and checklist to improve wording and installation guidance: change “Strict static typing” to “Strict static type checking” (mypy), add a link to the example project, and expand the Install & Run section to show alternative package manager commands (pip install -e ".[dev]", uv sync --extra dev, poetry install --extras dev). Also tidy a note's punctuation and update docs/CHECKLIST to use `uv sync --extra dev`.
@codecov
Copy link

codecov bot commented Feb 4, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@github-actions github-actions bot added the documentation Types: Improvements or additions to documentation label Feb 4, 2026
@Pymetheus Pymetheus merged commit c616dfd into main Feb 4, 2026
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Types: Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant