upstream/ipython Files · IPython/terminal/tests/test_help.py

Fixed formatting errors in rmagic R() docstring...

Fixed formatting errors in rmagic R() docstring Things now mostly render correctly in both terminal and HTML versions of the docs. Note that there are still numerous warnings regarding these magics. At least some of them appear to be from the debauched manner in which the docs are being generated from the @magic_arguments. In addition to the warnings you get when building the docs, if you look at the HTML source for, e.g., rmagic, you'll see that the options are formatted in numerous ways. I get a "--" converted to an en-dash (–) for example. In case you're looking at this in a system that messes up the formatting of the HTML code-point above, the en-dash is 8211.

MinRK - - Load All Authors

File last commit:

r12357:150bcc8a


                r12536:ddcf4b0f

Download file

             test_help.py
        
                    37 lines
            
             | 1.2 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / terminal / tests / test_help.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      """Test help output of various IPython entry points"""

      #-----------------------------------------------------------------------------

      #  Copyright (C) 2013 The IPython Development Team

      #

      #  Distributed under the terms of the BSD License.  The full license is in

      #  the file COPYING, distributed as part of this software.

      #-----------------------------------------------------------------------------

      #-----------------------------------------------------------------------------

      # Imports

      #-----------------------------------------------------------------------------

      import IPython.testing.tools as tt

      #-----------------------------------------------------------------------------

      # Tests

      #-----------------------------------------------------------------------------

      def test_ipython_help():

          tt.help_all_output_test()

      def test_profile_help():

          tt.help_all_output_test("profile")

      def test_profile_list_help():

          tt.help_all_output_test("profile list")

      def test_profile_create_help():

          tt.help_all_output_test("profile create")

      def test_locate_help():

          tt.help_all_output_test("locate")

      def test_locate_profile_help():

          tt.help_all_output_test("locate profile")

	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

				"""Test help output of various IPython entry points"""

				#-----------------------------------------------------------------------------
				# Copyright (C) 2013 The IPython Development Team
				#
				# Distributed under the terms of the BSD License. The full license is in
				# the file COPYING, distributed as part of this software.
				#-----------------------------------------------------------------------------

				#-----------------------------------------------------------------------------
				# Imports
				#-----------------------------------------------------------------------------

				import IPython.testing.tools as tt

				#-----------------------------------------------------------------------------
				# Tests
				#-----------------------------------------------------------------------------


				def test_ipython_help():
				tt.help_all_output_test()

				def test_profile_help():
				tt.help_all_output_test("profile")

				def test_profile_list_help():
				tt.help_all_output_test("profile list")

				def test_profile_create_help():
				tt.help_all_output_test("profile create")

				def test_locate_help():
				tt.help_all_output_test("locate")

				def test_locate_profile_help():
				tt.help_all_output_test("locate profile")