Pre-RFC: Documentation Test Names

I was working on a project with a bunch of documentation tests, and found the test runner's output to be somewhat unhelpful. In particular, when a doctest in a module with a bunch of other doctests failed, I had to go to the line number to see what the test did, or try to identify the test by the error message. Additionally, it was hard to see which doctests were running.

So, I wrote a simple RFC that proposes the ability to add metadata of the form name=IDENT to documentation test code block info strings. Markdown supports space-separated multi-word code block info strings, so this isn't an extension of markdown.

I'd be interested to hear if you think this is a good idea, or not, and any improvements/suggestions you might have.

You can read the RFC here.

Pre-RFCs belong in the internals forum:

2 Likes

Thanks, I'll repost there!