Skip to content

Commit 83fb930

Browse files
committed
Added docstrings for modules plot_canvas and plot_curve
1 parent 8808ef2 commit 83fb930

File tree

8 files changed

+775
-19
lines changed

8 files changed

+775
-19
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,9 @@ features are already implemented in `guiqwt`.
6262

6363
Other API compatibility issues with `Qwt`:
6464

65-
- `QwtPlot.MinimizeMemory` option was removed as this option has no sense
66-
in python-qwt (the polyline plotting is not taking more memory than the
67-
array data that is already there).
65+
- `QwtPlotCurve.MinimizeMemory` option was removed as this option has no
66+
sense in `python-qwt` (the polyline plotting is not taking more memory
67+
than the array data that is already there).
6868

6969
- `QwtPlotCurve.Fitted` option was removed as this option is not supported
7070
at the moment.

doc/overview.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ features are already implemented in `guiqwt`.
3636

3737
Other API compatibility issues with `Qwt`:
3838

39-
- `QwtPlot.MinimizeMemory` option was removed as this option has no sense
40-
in python-qwt (the polyline plotting is not taking more memory than the
41-
array data that is already there).
39+
- `QwtPlotCurve.MinimizeMemory` option was removed as this option has no
40+
sense in python-qwt (the polyline plotting is not taking more memory
41+
than the array data that is already there).
4242

4343
- `QwtPlotCurve.Fitted` option was removed as this option is not supported
4444
at the moment.

doc/reference/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,5 @@ Main `python-qwt` classes:
1313
legend_data
1414
legend_label
1515
plot
16+
plot_canvas
17+
plot_curve

doc/reference/plot_canvas.rst

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

doc/reference/plot_curve.rst

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

qwt/plot.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ def insertItem(self, item):
139139
"""
140140
Insert a plot item
141141
142-
:param QwtPlotItem item: PlotItem
142+
:param qwt.plot.QwtPlotItem item: PlotItem
143143
144144
.. seealso::
145145
@@ -151,7 +151,7 @@ def removeItem(self, item):
151151
"""
152152
Remove a plot item
153153
154-
:param QwtPlotItem item: PlotItem
154+
:param qwt.plot.QwtPlotItem item: PlotItem
155155
156156
.. seealso::
157157
@@ -231,7 +231,7 @@ class QwtPlot(QFrame, QwtPlotDict):
231231
are calculated from the plot items, using algorithms (`QwtScaleEngine`)
232232
which can be configured separately for each axis.
233233
234-
The simpleplot example is a good starting point to see how to set up a
234+
The following example is a good starting point to see how to set up a
235235
plot widget::
236236
237237
from qwt.qt.QtGui import QApplication
@@ -1476,7 +1476,7 @@ def updateLegend(self, plotItem=None):
14761476
If plotItem is None, emit QwtPlot.SIG_LEGEND_DATA_CHANGED for all
14771477
plot item. Otherwise, emit the signal for passed plot item.
14781478
1479-
:param QwtPlotItem plotItem: Plot item
1479+
:param qwt.plot.QwtPlotItem plotItem: Plot item
14801480
14811481
.. seealso::
14821482
@@ -1501,7 +1501,7 @@ def updateLegendItems(self, plotItem, legendData):
15011501
Call `QwtPlotItem.updateLegend()`, when the
15021502
`QwtPlotItem.LegendInterest` flag is set.
15031503
1504-
:param QwtPlotItem plotItem: Plot item
1504+
:param qwt.plot.QwtPlotItem plotItem: Plot item
15051505
:param list legendData: Entries to be displayed for the plot item ( usually 1 )
15061506
15071507
.. seealso::
@@ -1518,7 +1518,7 @@ def attachItem(self, plotItem, on):
15181518
"""
15191519
Attach/Detach a plot item
15201520
1521-
:param QwtPlotItem plotItem: Plot item
1521+
:param qwt.plot.QwtPlotItem plotItem: Plot item
15221522
:param bool on: When true attach the item, otherwise detach it
15231523
"""
15241524
if plotItem.testItemInterest(QwtPlotItem.LegendInterest):
@@ -1673,7 +1673,7 @@ def attach(self, plot):
16731673
call to attach (if necessary). If a None argument is passed, it will
16741674
detach from any `QwtPlot` it was attached to.
16751675
1676-
:param QwtPlot plot: Plot widget
1676+
:param qwt.plot.QwtPlot plot: Plot widget
16771677
16781678
.. seealso::
16791679
@@ -2166,7 +2166,7 @@ def updateLegend(self, item, data):
21662166
updateLegend() is only called when the LegendInterest interest
21672167
is enabled. The default implementation does nothing.
21682168
2169-
:param QwtPlotItem item: Plot item to be displayed on a legend
2169+
:param qwt.plot.QwtPlotItem item: Plot item to be displayed on a legend
21702170
:param list data: Attributes how to display item on the legend
21712171
21722172
.. note::

0 commit comments

Comments
 (0)