Skip to content

Commit 7dd5615

Browse files
committed
Added docstrings for graphic, interval and legend modules
1 parent 7e9d08e commit 7dd5615

File tree

8 files changed

+711
-8
lines changed

8 files changed

+711
-8
lines changed

doc/reference/graphic.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
.. automodule:: qwt.graphic
2+
:members:

doc/reference/index.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
Reference
22
=========
33

4-
python-qwt API:
4+
Main `python-qwt` classes:
55

66
.. toctree::
77
:maxdepth: 2
88

99
color_map
10+
graphic
11+
interval
12+
legend

doc/reference/interval.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
.. automodule:: qwt.interval
2+
:members:

doc/reference/legend.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
.. automodule:: qwt.legend
2+
:members:

qwt/color_map.py

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,21 @@
66
# (see LICENSE file for more details)
77

88
"""
9-
qwt.color_map
10-
-------------
11-
12-
The `color_map` module provides the `QwtColorMap` base class and derived
13-
classes.
9+
QwtColorMap
10+
-----------
1411
1512
.. autoclass:: QwtColorMap
1613
:members:
1714
15+
QwtLinearColorMap
16+
-----------------
17+
1818
.. autoclass:: QwtLinearColorMap
1919
:members:
2020
21+
QwtAlphaColorMap
22+
----------------
23+
2124
.. autoclass:: QwtAlphaColorMap
2225
:members:
2326
"""
@@ -164,7 +167,7 @@ def color(self, interval, value):
164167
165168
Map a value into a color
166169
167-
:param QwtInterval interval: valid interval for value
170+
:param qwt.interval.QwtInterval interval: valid interval for value
168171
:param float value: value
169172
:return: the color corresponding to value
170173
@@ -189,7 +192,7 @@ def colorTable(self, interval):
189192
190193
Build and return a color map of 256 colors
191194
192-
:param QwtInterval interval: range for the values
195+
:param qwt.interval.QwtInterval interval: range for the values
193196
:return: a color table, that can be used for a `QImage`
194197
195198
The color table is needed for rendering indexed images in combination

0 commit comments

Comments
 (0)