File: help.rst

package info (click to toggle)
spyder 3.1.3+dfsg1-3
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 7,552 kB
  • ctags: 4,851
  • sloc: python: 41,887; xml: 220; makefile: 23; sh: 6
file content (34 lines) | stat: -rw-r--r-- 1,020 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
Help
====

The help plugin works together with the :doc:`console` and the 
:doc:`editor`: it shows automatically documentation available when the 
user is instantiating a class or calling a function (pressing the left 
parenthesis key after a valid function or class name triggers a call
in the help pane).

Note that this automatic link may be disabled by pressing the "Lock" button 
(at the top right corner of the window).

Of course, one can use the documentation viewer directly by entering an object 
name in the editable combo box field, or by selecting old documentation requests
in the combo box.

Plain text mode:

.. image:: images/help_plain.png

Rich text mode:

.. image:: images/help_rich.png

Sometimes, when docstrings are not available or not sufficient to document the 
object, the documentation viewer can show the source code (if available, i.e. 
if the object is pure Python):

.. image:: images/help_source.png

Related plugins:

* :doc:`console`
* :doc:`editor`