summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRicardo Wurmus <rekado@elephly.net>2019-06-04 15:39:31 +0200
committerRicardo Wurmus <rekado@elephly.net>2019-06-04 15:39:31 +0200
commitb206bb2a645694d576bac753a401f9757b609175 (patch)
tree9fb43044c486857c71370fd5763d845e4761bf24
parentba6b58b0e27ad23404335f3f6927eb5b5fa23848 (diff)
pict: vline: Add docstring.
* pict.scm (vline): Add docstring.
-rw-r--r--pict.scm10
1 files changed, 7 insertions, 3 deletions
diff --git a/pict.scm b/pict.scm
index 21312b4..60b7b12 100644
--- a/pict.scm
+++ b/pict.scm
@@ -558,9 +558,13 @@ are accepted to override the line color and line thickness."
#:color color #:stroke-width stroke-width)))
(define* (vline w h
- #:key
- (color "black")
- (stroke-width 1))
+ #:key
+ (color "black")
+ (stroke-width 1))
+ "Return a vertical line segment of height H. The bounding box width
+is W and the line is drawn in the horizontal center of the bounding
+box. The keys COLOR (a string) and STROKE-WIDTH (a number) are
+accepted to override the line color and line thickness."
(let ((hcenter (exact->inexact (/ w 2))))
(line hcenter 0 hcenter h w h
#:color color #:stroke-width stroke-width)))