Conversation
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #101
Acceptance criterion (verbatim):
The issue let each fence either run in CI or move into a doctest. The maintainer chose runnable examples, written as standard
pycondoctest sessions (>>>prompts followed by the expected output).What changed
README.md: every Python example is now apyconblock, including the ones that were already running. The four that used to be skipped:plot(...).plotsignature: the annotated pseudo-signature, which wasn't valid Python, is now a real call that passes every parameter by keyword with its default noted. The parameter list below it now also documentsserver_timeoutandblock.stop_server/get_server_statusexamples moved up into Quick start. Their documented output (No active server to stop,server_info: None) is only true before any chart is plotted. Their API-reference entries now point there.plot()'s real console output is shown as the expected output.# doctest: +ELLIPSISmatches the parts that change each run (port, timestamp) as..., so the README needs noredirect_stdoutworkaround. Each call passesopen_browser=False, block=Falseso it runs unattended, and a sentence explains dropping those in a normal script.tests/test_readme_doctest.py(new): runspython -m doctest README.mdin a subprocess. That's the command the README gives readers, and the subprocess keeps the real server thread and session registry out of the pytest worker. This test does the executing, because rhiza's README check only runs```pythonfences. It uses nopytest.inichange (that file is template-owned). I checked that it fails: a copy of the README with one wrong output line exits 1.Gates
make fmt: pass (markdownlint included)make rhiza-test: pass, 32 passed, 3 skipped (no version tags). There are nopythonfences left for its README runner, so it now passes trivially on that part. The examples are exercised bymake testinstead.make test: pass, 179 tests (including the README doctest), 100% coveragepython -m doctest README.md: passcheck_doc_examples.py --source-root src: no+RHIZA_SKIPfencesCloses #101
🤖 Generated with Claude Code