Tidal icon indicating copy to clipboard operation
Tidal copied to clipboard

Haddock comment for `legato` (and some others) missing / in the wrong place

Open jwaldmann opened this issue 5 years ago • 1 comments

This seems wrong (https://hackage.haskell.org/package/tidal-1.4.7/docs/Sound-Tidal-Params.html#v:legato )

legato :: Pattern Double -> ControlPattern

a pattern of numbers from 0 to 1. Skips the beginning of each sample, e.g. `0.25` to cut off the first quarter from each sample.

Using `begin "-1"` combined with `cut "-1"` means that when the sample cuts itself ..

(same output for :doc legato in ghci).

Relevant source code: https://github.com/tidalcycles/Tidal/blob/b85a76abe30da3ad32e550c70a912817637047ce/src/Sound/Tidal/Params.hs#L106

{-|  a pattern ...         <== this text is used
-}
begin, legato :: ...
..
--legato controls ...   <== while this should be used
legato = pF "legato"

I can send PR, but not right now. Just documenting the issue here so that I don't forget.

jwaldmann avatar Jan 09 '20 18:01 jwaldmann

Hello! I wanted to see if I could help around in the community :) Is this issue still open for contribution?

madamsapple avatar May 02 '24 16:05 madamsapple