##// END OF EJS Templates
add a little detail to custom repr method docs (#13945)...
add a little detail to custom repr method docs (#13945) These docs are a bit sparse, so I added a couple details that might help implementers: - explicitly state the return type, rather than only via example - give some examples of PNG, HTML - note that formatters shouldn't be sensitive to other formats related to https://github.com/Textualize/rich/pull/2806 which didn't follow the spec, in part I think because the docs weren't explicit enough about exactly what a formatter should do.

File last commit:

r7777:2255c2b8
r28126:29190f63 merge
Show More
test_example.txt
24 lines | 730 B | text/plain | TextLexer
=====================================
Tests in example form - pure python
=====================================
This file contains doctest examples embedded as code blocks, using normal
Python prompts. See the accompanying file for similar examples using IPython
prompts (you can't mix both types within one file). The following will be run
as a test::
>>> 1+1
2
>>> print ("hello")
hello
More than one example works::
>>> s="Hello World"
>>> s.upper()
'HELLO WORLD'
but you should note that the *entire* test file is considered to be a single
test. Individual code blocks that fail are printed separately as ``example
failures``, but the whole file is still counted and reported as one test.