##// END OF EJS Templates
Fix docstring syntax to be properly parsed by numpydoc.
Matthias Bussonnier -
Show More
@@ -1896,9 +1896,14 b' class InteractiveShell(SingletonConfigurable):'
1896 exception or returns an invalid result, it will be immediately
1896 exception or returns an invalid result, it will be immediately
1897 disabled.
1897 disabled.
1898
1898
1899 Notes
1900 -----
1901
1899 WARNING: by putting in your own exception handler into IPython's main
1902 WARNING: by putting in your own exception handler into IPython's main
1900 execution loop, you run a very good chance of nasty crashes. This
1903 execution loop, you run a very good chance of nasty crashes. This
1901 facility should only be used if you really know what you are doing."""
1904 facility should only be used if you really know what you are doing.
1905 """
1906
1902 if not isinstance(exc_tuple, tuple):
1907 if not isinstance(exc_tuple, tuple):
1903 raise TypeError("The custom exceptions must be given as a tuple.")
1908 raise TypeError("The custom exceptions must be given as a tuple.")
1904
1909
@@ -2216,12 +2221,15 b' class InteractiveShell(SingletonConfigurable):'
2216
2221
2217 Returns
2222 Returns
2218 -------
2223 -------
2219 text : string
2224 text : string
2220 The actual text that was completed.
2225 The actual text that was completed.
2221
2226
2222 matches : list
2227 matches : list
2223 A sorted list with all possible completions.
2228 A sorted list with all possible completions.
2224
2229
2230
2231 Notes
2232 -----
2225 The optional arguments allow the completion to take more context into
2233 The optional arguments allow the completion to take more context into
2226 account, and are part of the low-level completion API.
2234 account, and are part of the low-level completion API.
2227
2235
@@ -2230,7 +2238,8 b' class InteractiveShell(SingletonConfigurable):'
2230 exposing it as a method, it can be used by other non-readline
2238 exposing it as a method, it can be used by other non-readline
2231 environments (such as GUIs) for text completion.
2239 environments (such as GUIs) for text completion.
2232
2240
2233 Simple usage example:
2241 Examples
2242 --------
2234
2243
2235 In [1]: x = 'hello'
2244 In [1]: x = 'hello'
2236
2245
General Comments 0
You need to be logged in to leave comments. Login now