##// END OF EJS Templates
some manual fixes
Matthias Bussonnier -
Show More
@@ -2057,16 +2057,14 b' class InteractiveShell(SingletonConfigurable):'
2057 Parameters
2057 Parameters
2058 ----------
2058 ----------
2059
2059
2060 text : string
2060 text : string
2061 A string of text to be completed on. It can be given as empty and
2061 A string of text to be completed on. It can be given as empty and
2062 instead a line/position pair are given. In this case, the
2062 instead a line/position pair are given. In this case, the
2063 completer itself will split the line like readline does.
2063 completer itself will split the line like readline does.
2064
2064 line : string, optional
2065 line : string, optional
2065 The complete line that text is part of.
2066 The complete line that text is part of.
2066 cursor_pos : int, optional
2067
2067 The position of the cursor on the input line.
2068 cursor_pos : int, optional
2069 The position of the cursor on the input line.
2070
2068
2071 Returns
2069 Returns
2072 -------
2070 -------
@@ -2606,7 +2604,7 b' class InteractiveShell(SingletonConfigurable):'
2606 ----------
2604 ----------
2607 fname : string
2605 fname : string
2608 The name of the file to be executed.
2606 The name of the file to be executed.
2609 where : tuple
2607 *where : tuple
2610 One or two namespaces, passed to execfile() as (globals,locals).
2608 One or two namespaces, passed to execfile() as (globals,locals).
2611 If only one is given, it is passed as both.
2609 If only one is given, it is passed as both.
2612 exit_ignore : bool (False)
2610 exit_ignore : bool (False)
@@ -302,7 +302,7 b' def find_file(obj) -> str:'
302 Returns
302 Returns
303 -------
303 -------
304 fname : str
304 fname : str
305 The absolute path to the file where the object was defined.
305 The absolute path to the file where the object was defined.
306 """
306 """
307 obj = _get_wrapped(obj)
307 obj = _get_wrapped(obj)
308
308
@@ -337,7 +337,7 b' def find_source_lines(obj):'
337 Returns
337 Returns
338 -------
338 -------
339 lineno : int
339 lineno : int
340 The line number where the object definition starts.
340 The line number where the object definition starts.
341 """
341 """
342 obj = _get_wrapped(obj)
342 obj = _get_wrapped(obj)
343
343
@@ -428,7 +428,6 b' class Inspector(Colorable):'
428
428
429 Examples
429 Examples
430 --------
430 --------
431
432 In [1]: class NoInit:
431 In [1]: class NoInit:
433 ...: pass
432 ...: pass
434
433
@@ -575,18 +574,17 b' class Inspector(Colorable):'
575 """Retrieve an info dict and format it.
574 """Retrieve an info dict and format it.
576
575
577 Parameters
576 Parameters
578 ==========
577 ----------
579
578 obj : any
580 obj: any
581 Object to inspect and return info from
579 Object to inspect and return info from
582 oname: str (default: ''):
580 oname: str (default: ''):
583 Name of the variable pointing to `obj`.
581 Name of the variable pointing to `obj`.
584 formatter: callable
582 formatter : callable
585 info:
583 info:
586 already computed information
584 already computed information
587 detail_level: integer
585 detail_level : integer
588 Granularity of detail level, if set to 1, give more information.
586 Granularity of detail level, if set to 1, give more information.
589 omit_sections: container[str]
587 omit_sections : container[str]
590 Titles or keys to omit from output (can be set, tuple, etc., anything supporting `in`)
588 Titles or keys to omit from output (can be set, tuple, etc., anything supporting `in`)
591 """
589 """
592
590
@@ -716,21 +714,19 b' class Inspector(Colorable):'
716 """Compute a dict with detailed information about an object.
714 """Compute a dict with detailed information about an object.
717
715
718 Parameters
716 Parameters
719 ==========
717 ----------
720
718 obj : any
721 obj: any
722 An object to find information about
719 An object to find information about
723 oname: str (default: ''):
720 oname : str (default: '')
724 Name of the variable pointing to `obj`.
721 Name of the variable pointing to `obj`.
725 info: (default: None)
722 info : (default: None)
726 A struct (dict like with attr access) with some information fields
723 A struct (dict like with attr access) with some information fields
727 which may have been precomputed already.
724 which may have been precomputed already.
728 detail_level: int (default:0)
725 detail_level : int (default:0)
729 If set to 1, more information is given.
726 If set to 1, more information is given.
730
727
731 Returns
728 Returns
732 =======
729 -------
733
734 An object info dict with known fields from `info_fields`. Keys are
730 An object info dict with known fields from `info_fields`. Keys are
735 strings, values are string or None.
731 strings, values are string or None.
736 """
732 """
@@ -962,7 +958,7 b' class Inspector(Colorable):'
962
958
963 - show_all(False): show all names, including those starting with
959 - show_all(False): show all names, including those starting with
964 underscores.
960 underscores.
965
961
966 - list_types(False): list all available object types for object matching.
962 - list_types(False): list all available object types for object matching.
967 """
963 """
968 #print 'ps pattern:<%r>' % pattern # dbg
964 #print 'ps pattern:<%r>' % pattern # dbg
General Comments 0
You need to be logged in to leave comments. Login now