~ubuntu-branches/ubuntu/trusty/spyder/trusty-proposed

« back to all changes in this revision

Viewing changes to doc_src/inspector.rst

• browse files at revision 3
• compare with another revision
• download diff
• download tarball
• view history from revision 3

Show diffs side-by-side

added

removed

doc_src/inspector.rst

 

1

Object inspector

 

2

================

 

3

 

 

4

The object inspector plugin works together with the :doc:`console` and the 

 

5

:doc:`extconsole`: it shows automatically documentation available when the 

 

6

user is instantiating a class or calling a function (pressing the left 

 

7

parenthesis key after a valid function or class name triggers the object 

 

8

inspector).

 

9

 

 

10

Note that this automatic link may be disabled by pressing the "Lock" button 

 

11

(at the top right corner of the window).

 

12

 

 

13

Of course, one can use the documentation viewer directly by entering an object 

 

14

name in the editable combo box field, or by selecting old documentation requests

 

15

in the combo box.

 

16

 

 

17

.. image:: images/inspector1.png

 

18

 

 

19

Sometimes, when docstrings are not available or not sufficient to document the 

 

20

object, the documentation viewer can show the source code (if available, i.e. 

 

21

if the object is pure Python):

 

22

 

 

23

.. image:: images/inspector2.png

 

24

 

 

25

Related plugins:

 

26

    * :doc:`console`

 

27

    * :doc:`extconsole`

• Older »

Loggerhead is a web-based interface for Breezy
Version: 2.0.1