upstream/ipython Files · IPython/core/tests/bad_all.py

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.

Thomas Kluyver - - Load All Authors

File last commit:

r22618:12e05563


                r28126:29190f63

Download file

             bad_all.py
        
                    14 lines
            
             | 206 B
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / core / tests / bad_all.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      """Module with bad __all__

      To test https://github.com/ipython/ipython/issues/9678

      """

      def evil():

          pass

      def puppies():

          pass

      __all__ = [evil,       # Bad

                 'puppies',  # Good

                ]

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

				"""Module with bad __all__

				To test https://github.com/ipython/ipython/issues/9678
				"""

				def evil():
				pass

				def puppies():
				pass

				__all__ = [evil, # Bad
				'puppies', # Good
				]