Skip to content

Commit

Permalink
D.TwoD.Arrow: clarify comments for arrow and arrow'
Browse files Browse the repository at this point in the history
  • Loading branch information
Brent Yorgey committed Nov 13, 2013
1 parent fdcdc92 commit 1ba6733
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions src/Diagrams/TwoD/Arrow.hs
Original file line number Diff line number Diff line change
Expand Up @@ -286,13 +286,16 @@ scaleFactor tr tw hw t
hv = hw *^ (tangentAtEnd tr # normalized)
v = trailOffset tr

-- | @arrow len@ creates an arrow of length @len@ with default parameters.
-- | @arrow len@ creates a default arrow of length @len@ with default

This comment has been minimized.

Copy link
@bergey

bergey Nov 14, 2013

Member

What does the first occurrence of 'default' mean?

This comment has been minimized.

Copy link
@byorgey

byorgey Nov 14, 2013

Member

I have no idea. I will remove it.

-- parameters, starting at the origin and ending at the point
-- @(len,0)@.
arrow :: Renderable (Path R2) b => Double -> Diagram b R2
arrow len = arrow' def len

-- | @arrow' opts len@ creates an arrow of length @len@ using the
-- given options. In particular, it scales the given 'arrowShaft'
-- so that the entire arrow has length @len@.
-- given options, starting at the origin and ending at the point
-- @(len,0)@. In particular, it scales the given 'arrowShaft' so
-- that the entire arrow has length @len@.
arrow' :: Renderable (Path R2) b => ArrowOpts -> Double -> Diagram b R2
arrow' opts len = dArrow # rotateBy (- dir)
where
Expand Down

0 comments on commit 1ba6733

Please sign in to comment.