Skip to content

Correct kernel and absorbing-boundary documentation - #926

Open
Golden007-prog wants to merge 1 commit into
LupoLab:mainfrom
Golden007-prog:docs/correct-stage-and-boundary-examples
Open

Golden007-prog wants to merge 1 commit into
LupoLab:mainfrom
Golden007-prog:docs/correct-stage-and-boundary-examples

Conversation

@Golden007-prog

Copy link
Copy Markdown

Summary

Part of #911. This covers three of the five checklist items:

  • Point the stage docstring to the kernel contract section that describes stage evaluation.
  • Explain that ORTHONORMALITY_TOLERANCE applies to the supplied mode set's overlaps, independently of quadrature accuracy.
  • Use a delay span that emits the warning shown in the absorbing-boundaries example.

The native build-record comment and Read the Docs watchdog are still open. This change adds no runtime behavior or API changes.

Verification

  • git diff --check, scoped uv run codespell, and uv run python -m numpydoc lint for both changed modules.
  • uv run poe docs with the lightweight environment — succeeded.
  • Executed the guide example on the reference setup. The original 1e-12 example emitted no walk-off warning, and the updated 1e-11 emitted one SolpropWarning with the documented guidance.

Prepared with Codex assistance.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 18, 2026 •

Copy link
Copy Markdown
Codex Review Summary: ✅ Completed

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-18T02:50:08.335229Z f3fa0b8 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@read-the-docs-community

Copy link
Copy Markdown

This branch has not been deployed

No deployments
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.

1 participant