Fix docstring markup errors

This commit is contained in:
Stefan van der Walt
2014-12-15 02:21:34 +02:00
parent a38b1c1257
commit 7f8cd65675
3 changed files with 12 additions and 10 deletions
+1 -1
View File
@@ -26,7 +26,7 @@ def _format_plugin_info_table(info_table, column_lengths):
info_table.insert(0, _separator('=', column_lengths))
info_table.insert(1, ('Plugin', 'Description'))
info_table.insert(2, _separator('-', column_lengths))
info_table.append(_separator('-', column_lengths))
info_table.append(_separator('=', column_lengths))
def _update_doc(doc):
+1 -1
View File
@@ -142,7 +142,7 @@ class Plugin(QtGui.QDialog):
plugin += Widget(...)
Widgets can adjust required or optional arguments of filter function or
parameters for the plugin. This is specified by the Widget's `ptype'.
parameters for the plugin. This is specified by the Widget's `ptype`.
"""
if widget.ptype == 'kwarg':
name = widget.name.replace(' ', '_')
+10 -8
View File
@@ -73,14 +73,16 @@ class ColorHistogram(PlotPlugin):
The selected pixels.
data : dict
The data describing the histogram and the selected region.
Keys:
- 'bins' : array of float, the bin boundaries for both
`a` and `b` channels.
- 'hist' : 2D array of float, the normalized histogram.
- 'edges' : tuple of array of float, the bin edges
along each dimension
- 'extents' : tuple of float, the left and right and
top and bottom of the selected region.
The dictionary contains:
- 'bins' : array of float
The bin boundaries for both `a` and `b` channels.
- 'hist' : 2D array of float
The normalized histogram.
- 'edges' : tuple of array of float
The bin edges along each dimension
- 'extents' : tuple of float
The left and right and top and bottom of the selected region.
"""
return (self.mask, self.data)