Skip to content

Commit a19c3e4

Browse files
committed
Fix more cross references.
1 parent 7e11098 commit a19c3e4

File tree

4 files changed

+11
-13
lines changed

4 files changed

+11
-13
lines changed

docs/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,13 +83,13 @@ def __getattr__(cls, name):
8383
nitpicky = True
8484

8585
nitpick_ignore = [
86-
# ("py:class", "object"),
86+
("py:class", "QApplication"),
8787
]
8888

8989
intersphinx_mapping = {
9090
"arrow": ("https://arrow.readthedocs.org/en/latest", None),
9191
"numpy": ("http://docs.scipy.org/doc/numpy-1.10.1", None),
92-
"python": ("https://docs.python.org/2.7", None),
92+
"python": ("https://docs.python.org/3.5", None),
9393
"PIL": ("https://pillow.readthedocs.org/en/3.2.x", None),
9494
}
9595

toyplot/data.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,7 @@ def keys(self):
284284
285285
Returns
286286
-------
287-
keys: sequence of string column names.
287+
keys: sequence of :class:`str` column names.
288288
"""
289289
return self._columns.keys()
290290

@@ -293,7 +293,7 @@ def values(self):
293293
294294
Returns
295295
-------
296-
values: sequence of numpy.ndarray columns.
296+
values: sequence of :class:`numpy.ndarray` columns.
297297
"""
298298
return self._columns.values()
299299

@@ -307,7 +307,7 @@ def metadata(self, column):
307307
308308
Returns
309309
-------
310-
metadata: dict containing key-value pairs.
310+
metadata: :class:`dict` containing key-value pairs.
311311
"""
312312
if column not in self._columns:
313313
raise ValueError("Unknown column name '%s'" % column)

toyplot/png.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,8 @@ def render(canvas, fobj=None, width=None, height=None, scale=None):
3636
3737
Returns
3838
-------
39-
png: PNG image data, or `None`
40-
PNG representation of `canvas`, or `None` if the caller specifies the
41-
`fobj` parameter.
39+
png: :class:`bytes` containing PNG image data, or `None`
40+
Returns `None` if the caller specifies the `fobj` parameter, returns the PNG image data otherwise.
4241
4342
Notes
4443
-----
@@ -68,7 +67,7 @@ def render_frames(canvas, width=None, height=None, scale=None):
6867
6968
Returns
7069
-------
71-
frames: Python generator expression that returns each PNG image in the sequence.
70+
frames: Sequence of :class:`bytes` objects containing PNG image data.
7271
The caller must iterate over the returned frames and is responsible for all
7372
subsequent processing, including disk I/O, video compression, etc.
7473

toyplot/reportlab/png.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,8 @@ def render(canvas, fobj=None, width=None, height=None, scale=None):
4848
4949
Returns
5050
-------
51-
png: PNG image data, or `None`
52-
PNG representation of `canvas`, or `None` if the caller specifies the
53-
`fobj` parameter.
51+
png: :class:`bytes` containing PNG image data, or `None`
52+
Returns `None` if the caller specifies the `fobj` parameter, returns the PNG image data otherwise.
5453
"""
5554
svg = toyplot.svg.render(canvas)
5655
scale = canvas._point_scale(width=width, height=height, scale=scale)
@@ -111,7 +110,7 @@ def render_frames(canvas, width=None, height=None, scale=None):
111110
112111
Returns
113112
-------
114-
frames: Python generator expression that returns each PNG image in the sequence.
113+
frames: Sequence of :class:`bytes` objects containing PNG image data.
115114
The caller must iterate over the returned frames and is responsible for all
116115
subsequent processing, including disk I/O, video compression, etc.
117116

0 commit comments

Comments
 (0)