Unambiguous alternate doctest format

Devin Jeanpierre avatarDevin Jeanpierre created an issue

Idea: abandon the format of

    >>> some_code
    ... more code
    some output

Instead, go for a format where the different _kinds_ of output are kept distinct. The different kinds of output are:

  • stdout
  • return value of an evaluated expression
  • sys.displayhook (superset of ^)
  • exceptions

(maybe stderr would be nice too).

Of those, stdout and sys.displayhook can be interleaved and cause problems, and in all cases it is difficult to find where stdout ends and the next thing begins. By separating these out explicitly, it would be clear.

Probably it's best to forget about writing my own parser and just piggyback on ReST, so this is listed under the Sphinx extension.

Comments (0)

  1. Log in to comment
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.