music-pitch-literal 1.3 → 1.3.1

raw patch · 2 files changed

+14/−8 lines, 2 filesPVP ok

version bump matches the API change (PVP)

API changes (from Hackage documentation)

Files

• music-pitch-literal.cabal +7/−2
• src/Music/Pitch/Literal.hs +7/−6

@@ -1,7 +1,7 @@  name:               music-pitch-literal-version:            1.3-cabal-version:      >= 1.2+version:            1.3.1+cabal-version:      >= 1.10 author:             Hans Hoglund maintainer:         Hans Hoglund license:            BSD3@@ -17,10 +17,15 @@      This library is part of the Music Suite, see <http://musicsuite.github.com>. +source-repository head+  type:             git+  location:         git://github.com/hanshoglund/music-pitch-literal.git+   library                         build-depends:          base >= 4 && < 5     hs-source-dirs: src+    default-language: Haskell2010     exposed-modules:         Music.Pitch.Literal     

@@ -17,8 +17,8 @@  module Music.Pitch.Literal ( -        PitchL(..),         IsPitch(..),+        PitchL(..),          cs'', ds'', es'', fs'', gs'', as'', bs'',         c'' , d'' , e'' , f'' , g'' , a'' , b'' ,@@ -42,17 +42,18 @@   ) where  -- |--- The 'PitchL' types is used to encode a pitch literal.+-- The 'PitchL' types is used to encode a pitch literal. You don't need to+-- think about this type unless you are implementing 'IsPitch'. ----- It is defined as /(class, alteration, octave)/, where+-- It is defined as @(class, alteration, octave)@, where -----     * /class/      is a pitch class number in /[0,6]/, starting from C.+--     * @class@      is a pitch class number in @[0..6]@, starting from C. -----     * /alteration/ is the number of semitones, i.e. 0 is natural, 1 for sharp 2 for double sharp, -1 for flat and -2 for double flat.+--     * @alteration@ is the number of semitones, i.e. 0 is natural, 1 for sharp 2 for double sharp, -1 for flat and -2 for double flat. --       Alteration is in 'Maybe' because some pitch representations differ between explicit and explicit accidentals, i.e. a diatonic --       pitch type may assume @(0,Nothing,4)@ to mean C sharp rather than C. -----     * /octave/     is octave number in scientific pitch notation.+--     * @octave@     is octave number in scientific pitch notation. -- -- Middle C is represented by the pitch literal @(0, Nothing, 4)@. --