Skip to content

Fix docs and docstrings - #57

Draft
ohno wants to merge 1 commit into
mainfrom
codex/issue-51-docs
Draft

Fix docs and docstrings#57
ohno wants to merge 1 commit into
mainfrom
codex/issue-51-docs

Conversation

@ohno

@ohno ohno commented Aug 14, 2026

Copy link
Copy Markdown
Member

Summary

  • add a concise README quick start
  • update the Rayleigh–Ritz, GEM, Free Complement, VNN, and VMC documentation as requested
  • clarify the operator-matrix docstring
  • include GEM in the architecture description and diagram

Validation

  • complete Documenter build passed with doctests, cross-references, docstring checks, and HTML rendering
  • confirmed the superseded headings, example, and reference text are absent
  • git diff --check

Closes #51


This pull request was developed with assistance from Codex using GPT-5.6 Sol with High reasoning effort.

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.

Fix docs and docstrings

1 participant