Add examples to docstrings that use actual Docassemble syntax, not python repl syntax - #1111
nonprofittechy wants to merge 2 commits into
Conversation
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
Several copy-pasted documentation examples contain incorrect or incomplete syntax.
Get a fresh assessment by requesting another Copilot review.
Review effort: Lite
Findings: 1
Open (2)
What changed in this PR
Updates AssemblyLine docstrings with Docassemble-native YAML, Mako, and Jinja2 examples.
Changes:
- Replaces Python REPL examples with practical Docassemble syntax.
- Adds examples across document, session, language, signing, people, and court APIs.
- Improves code-fence formatting and documentation rendering.
| File | Summary |
|---|---|
docassemble/AssemblyLine/sign.py |
Added signature and font examples. |
docassemble/AssemblyLine/sessions.py |
Added session examples; minor cleanup remains for adjacent examples and wording. |
docassemble/AssemblyLine/language.py |
Added language-selection examples. |
docassemble/AssemblyLine/custom_jinja_filters.py |
Updated filter examples; catchall example needs its module declaration. |
docassemble/AssemblyLine/al_general.py |
Added people and helper examples; repeated users declarations need correction. |
docassemble/AssemblyLine/al_document.py |
Added document and exhibit examples; one OCR event name is incorrect. |
docassemble/AssemblyLine/al_courts.py |
Added court-loader examples. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| `background_action()`; `to_pdf` must be an initialized DAFile: | ||
|
|
||
| ```yaml | ||
| event: al_exhibit_ocr_pages_bg |
| With `saved_filename` and `saved_session_id` identifying the saved | ||
| session selected by the user, in an interview code block: |
|
@copilot Fix the code for all comments in this review thread. When a review comment includes a suggested change, apply the suggestion exactly. Do not make changes beyond what is described in the linked review thread. |
Co-authored-by: nonprofittechy <7645641+nonprofittechy@users.noreply.github.com>
Addressed in 89da353. |
This only edits docstrings. Previewed all of the rendered doc pages in local Docusaurus checkout to make sure they look good and checked accuracy of examples.