##// END OF EJS Templates
upstream » ipython
RSS

Clone from https://github.com/ipython/ipython.git

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.
Nikita Kniazev - - Load All Authors

File last commit:

r26933:1720e062
r28126:29190f63 merge
Show More
test_exampleip.txt
30 lines | 814 B | text/plain | TextLexer
/ IPython / testing / plugin / test_exampleip.txt
History | Annotation | Raw |Copy content |Copy permalink
=================================
Tests in example form - IPython
=================================
You can write text files with examples that use IPython prompts (as long as you
use the nose ipython doctest plugin), but you can not mix and match prompt
styles in a single file. That is, you either use all ``>>>`` prompts or all
IPython-style prompts. Your test suite *can* have both types, you just need to
put each type of example in a separate. Using IPython prompts, you can paste
directly from your session::
In [5]: s="Hello World"
In [6]: s.upper()
Out[6]: 'HELLO WORLD'
Another example::
In [8]: 1+3
Out[8]: 4
Just like in IPython docstrings, you can use all IPython syntax and features::
In [9]: !echo hello
hello
In [10]: a='hi'
In [11]: !echo $a
hi