##// END OF EJS Templates
DOC: Some more autoformatting of docstrings....
Matthias Bussonnier -
Show More
@@ -80,8 +80,7 b' def embed_kernel(module=None, local_ns=None, **kwargs):'
80 The module to load into IPython globals (default: caller)
80 The module to load into IPython globals (default: caller)
81 local_ns : dict, optional
81 local_ns : dict, optional
82 The namespace to load into IPython user namespace (default: caller)
82 The namespace to load into IPython user namespace (default: caller)
83
83 **kwargs : various, optional
84 kwargs : various, optional
85 Further keyword args are relayed to the IPKernelApp constructor,
84 Further keyword args are relayed to the IPKernelApp constructor,
86 allowing configuration of the Kernel. Will only have an effect
85 allowing configuration of the Kernel. Will only have an effect
87 on the first embed_kernel call for a given process.
86 on the first embed_kernel call for a given process.
@@ -112,13 +111,12 b' def start_ipython(argv=None, **kwargs):'
112
111
113 Parameters
112 Parameters
114 ----------
113 ----------
115
116 argv : list or None, optional
114 argv : list or None, optional
117 If unspecified or None, IPython will parse command-line options from sys.argv.
115 If unspecified or None, IPython will parse command-line options from sys.argv.
118 To prevent any command-line parsing, pass an empty list: `argv=[]`.
116 To prevent any command-line parsing, pass an empty list: `argv=[]`.
119 user_ns : dict, optional
117 user_ns : dict, optional
120 specify this dictionary to initialize the IPython user namespace with particular values.
118 specify this dictionary to initialize the IPython user namespace with particular values.
121 kwargs : various, optional
119 **kwargs : various, optional
122 Any other kwargs will be passed to the Application constructor,
120 Any other kwargs will be passed to the Application constructor,
123 such as `config`.
121 such as `config`.
124 """
122 """
@@ -138,13 +136,12 b' def start_kernel(argv=None, **kwargs):'
138
136
139 Parameters
137 Parameters
140 ----------
138 ----------
141
142 argv : list or None, optional
139 argv : list or None, optional
143 If unspecified or None, IPython will parse command-line options from sys.argv.
140 If unspecified or None, IPython will parse command-line options from sys.argv.
144 To prevent any command-line parsing, pass an empty list: `argv=[]`.
141 To prevent any command-line parsing, pass an empty list: `argv=[]`.
145 user_ns : dict, optional
142 user_ns : dict, optional
146 specify this dictionary to initialize the IPython user namespace with particular values.
143 specify this dictionary to initialize the IPython user namespace with particular values.
147 kwargs : various, optional
144 **kwargs : various, optional
148 Any other kwargs will be passed to the Application constructor,
145 Any other kwargs will be passed to the Application constructor,
149 such as `config`.
146 such as `config`.
150 """
147 """
1 NO CONTENT: modified file
NO CONTENT: modified file
1 NO CONTENT: modified file
NO CONTENT: modified file
1 NO CONTENT: modified file
NO CONTENT: modified file
@@ -763,11 +763,11 b' def match_dict_keys(keys: List[Union[str, bytes, Tuple[Union[str, bytes]]]], pre'
763
763
764 Parameters
764 Parameters
765 ----------
765 ----------
766 keys:
766 keys
767 list of keys in dictionary currently being completed.
767 list of keys in dictionary currently being completed.
768 prefix:
768 prefix
769 Part of the text already typed by the user. E.g. `mydict[b'fo`
769 Part of the text already typed by the user. E.g. `mydict[b'fo`
770 delims:
770 delims
771 String of delimiters to consider when finding the current key.
771 String of delimiters to consider when finding the current key.
772 extra_prefix: optional
772 extra_prefix : optional
773 Part of the text already typed in multi-key index cases. E.g. for
773 Part of the text already typed in multi-key index cases. E.g. for
@@ -993,7 +993,7 b' def _formatparamchildren(parameter) -> str:'
993
993
994 Parameters
994 Parameters
995 ----------
995 ----------
996 parameter:
996 parameter
997 Jedi's function `Param`
997 Jedi's function `Param`
998
998
999 Returns
999 Returns
@@ -104,22 +104,16 b' class CrashHandler(object):'
104 app : Application
104 app : Application
105 A running :class:`Application` instance, which will be queried at
105 A running :class:`Application` instance, which will be queried at
106 crash time for internal information.
106 crash time for internal information.
107
108 contact_name : str
107 contact_name : str
109 A string with the name of the person to contact.
108 A string with the name of the person to contact.
110
111 contact_email : str
109 contact_email : str
112 A string with the email address of the contact.
110 A string with the email address of the contact.
113
114 bug_tracker : str
111 bug_tracker : str
115 A string with the URL for your project's bug tracker.
112 A string with the URL for your project's bug tracker.
116
117 show_crash_traceback : bool
113 show_crash_traceback : bool
118 If false, don't print the crash traceback on stderr, only generate
114 If false, don't print the crash traceback on stderr, only generate
119 the on-disk report
115 the on-disk report
120
116 Non-argument instance attributes
121 Non-argument instance attributes:
122
123 These instances contain some non-argument attributes which allow for
117 These instances contain some non-argument attributes which allow for
124 further customization of the crash handler's behavior. Please see the
118 further customization of the crash handler's behavior. Please see the
125 source for further details.
119 source for further details.
@@ -109,7 +109,6 b' class Tracer(object):'
109
109
110 Parameters
110 Parameters
111 ----------
111 ----------
112
113 colors : str, optional
112 colors : str, optional
114 The name of the color scheme to use, it must be one of IPython's
113 The name of the color scheme to use, it must be one of IPython's
115 valid color schemes. If not given, the function will default to
114 valid color schemes. If not given, the function will default to
@@ -133,12 +133,11 b' def display('
133 clear : bool, optional
133 clear : bool, optional
134 Should the output area be cleared before displaying anything? If True,
134 Should the output area be cleared before displaying anything? If True,
135 this will wait for additional output before clearing. [default: False]
135 this will wait for additional output before clearing. [default: False]
136 kwargs: additional keyword-args, optional
136 **kwargs : additional keyword-args, optional
137 Additional keyword-arguments are passed through to the display publisher.
137 Additional keyword-arguments are passed through to the display publisher.
138
138
139 Returns
139 Returns
140 -------
140 -------
141
142 handle: DisplayHandle
141 handle: DisplayHandle
143 Returns a handle on updatable displays for use with :func:`update_display`,
142 Returns a handle on updatable displays for use with :func:`update_display`,
144 if `display_id` is given. Returns :any:`None` if no `display_id` is given
143 if `display_id` is given. Returns :any:`None` if no `display_id` is given
@@ -146,7 +145,6 b' def display('
146
145
147 Examples
146 Examples
148 --------
147 --------
149
150 >>> class Json(object):
148 >>> class Json(object):
151 ... def __init__(self, json):
149 ... def __init__(self, json):
152 ... self.json = json
150 ... self.json = json
@@ -185,12 +183,10 b' def display('
185
183
186 See Also
184 See Also
187 --------
185 --------
188
189 :func:`update_display`
186 :func:`update_display`
190
187
191 Notes
188 Notes
192 -----
189 -----
193
194 In Python, objects can declare their textual representation using the
190 In Python, objects can declare their textual representation using the
195 `__repr__` method. IPython expands on this idea and allows objects to declare
191 `__repr__` method. IPython expands on this idea and allows objects to declare
196 other, rich representations including:
192 other, rich representations including:
@@ -300,15 +296,13 b' def update_display(obj, *, display_id, **kwargs):'
300
296
301 Parameters
297 Parameters
302 ----------
298 ----------
303
299 obj
304 obj:
305 The object with which to update the display
300 The object with which to update the display
306 display_id: keyword-only
301 display_id : keyword-only
307 The id of the display to update
302 The id of the display to update
308
303
309 See Also
304 See Also
310 --------
305 --------
311
312 :func:`display`
306 :func:`display`
313 """
307 """
314 kwargs['update'] = True
308 kwargs['update'] = True
@@ -343,10 +337,9 b' class DisplayHandle(object):'
343
337
344 Parameters
338 Parameters
345 ----------
339 ----------
346
340 obj
347 obj:
348 object to display
341 object to display
349 **kwargs:
342 **kwargs
350 additional keyword arguments passed to display
343 additional keyword arguments passed to display
351 """
344 """
352 display(obj, display_id=self.display_id, **kwargs)
345 display(obj, display_id=self.display_id, **kwargs)
@@ -356,10 +349,9 b' class DisplayHandle(object):'
356
349
357 Parameters
350 Parameters
358 ----------
351 ----------
359
352 obj
360 obj:
361 object to display
353 object to display
362 **kwargs:
354 **kwargs
363 additional keyword arguments passed to update_display
355 additional keyword arguments passed to update_display
364 """
356 """
365 update_display(obj, display_id=self.display_id, **kwargs)
357 update_display(obj, display_id=self.display_id, **kwargs)
General Comments 0
You need to be logged in to leave comments. Login now