Skip to content

Commit e61eff8

Browse files
committed
Document +nan.0 behavior for lines renderer
1 parent 7499d03 commit e61eff8

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

plot-doc/plot/scribblings/renderer2d.scrbl

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -264,8 +264,12 @@ For example, a parabola, an inverse parabola, and the reflection line:
264264
[#:alpha alpha (real-in 0 1) (line-alpha)]
265265
[#:label label (or/c string? pict? #f) #f]
266266
) renderer2d?]{
267-
Returns a renderer that draws lines.
268-
This is directly useful for plotting a time series, such as a random walk:
267+
268+
Returns a renderer that draws lines connecting the points in the input
269+
sequence @(racket vs).
270+
271+
This is directly useful for plotting a time series, such as a random walk:
272+
269273
@interaction[#:eval plot-eval
270274
(plot (lines
271275
(reverse
@@ -276,7 +280,12 @@ This is directly useful for plotting a time series, such as a random walk:
276280

277281
The @(racket parametric) and @(racket polar) functions are defined using @(racket lines).
278282

279-
@history[#:changed "7.9" "Added support for pictures for #:label"]
283+
If any of the points in @(racket vs) is @(racket +nan.0), no line segment
284+
will be drawn at that position. This can be used to draw several
285+
independent data sets with one @(racket lines) renderer, improving rendering
286+
performence if the datasets contain a large number of points.
287+
288+
@history[#:changed "7.9" "Added support for pictures for #:label"]
280289
}
281290

282291
@defproc[(parametric [f (real? . -> . (sequence/c real?))]

0 commit comments

Comments
 (0)