Skip to content

docs(agents): tell packages to split a long ipython block #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jmineau merged 1 commit into from
Oct 22, 2026
Merged

docs(agents): tell packages to split a long ipython block #20

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion template/AGENTS.md.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,9 @@ when one breaks.

A block that raises or warns fails the build; `:okexcept:` or `:okwarning:`
under the directive allows one that is meant to. All `.rst` pages share one
session, so each page imports and defines what it uses.
session, so each page imports and defines what it uses. Split a long block so
that no multi-line statement is its 10th (or 100th) statement: the directive
runs only the first line of that one.
{%- if docs_notebooks %}
- **Code cells in a Markdown page:** a page (`.md`) under `docs/` can mix prose
with code cells that run, each showing what it prints and plots, as in a
Expand Down
Loading