Skip to content

Conversation

@c-randall
Copy link
Collaborator

Description

Remove TODOs and fill in the project overview section in the development section of the documentation. Also, remove some old references to thevenin from old copy/paste.

Type of change

  • New feature (non-breaking change which adds functionality)
  • Optimization (back-end change that improves speed/readability/etc.)
  • Bug fix (non-breaking change which fixes an issue)
  • Chore (any other clean up, maintenance, etc.)

Key checklist:

  • No style issues: $ nox -s linter [-- format]
  • Code is free of misspellings: $ nox -s codespell [-- write]
  • All tests pass: $ nox -s tests
  • Badges are updated: $ nox -s badges

Further checks:

  • The documentation builds: $ nox -s docs.
  • Code is commented, particularly in hard-to-understand areas.
  • Tests are added that prove fix is effective or that feature works.

@c-randall c-randall marked this pull request as ready for review December 15, 2025 17:07
@c-randall c-randall merged commit 08b4c7f into main Dec 15, 2025
10 checks passed
@c-randall c-randall deleted the docs/overview branch December 15, 2025 17:08
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