lue-bird/elm-docs-diff/1.0.1

NOTE: the latest version is 1.0.2

Elm.SemanticMagnitude

Severity of a diff

= Major
| Minor
| Patch

What kind of version bump would be necessary?

  • Major: stuff has been deleted or a type has changed
  • Minor: stuff has been added and the types still fit
  • Patch: no API changes, either implementation or documentation changes

Choose maximum severity between the two Magnitudes

[ Elm.SemanticMagnitude.Minor
, Elm.SemanticMagnitude.Major
, Elm.SemanticMagnitude.Patch
]
    |> List.foldl
        (\next soFar -> ( soFar, next ) |> Elm.SemanticMagnitude.theMoreSevere)
        Elm.SemanticMagnitude.Patch
--> Elm.SemanticMagnitude.Major
name : Magnitude -> String

Lowercase name

"-- This is a "
    ++ (Elm.SemanticMagnitude.Minor |> Elm.SemanticMagnitude.name |> String.toUpper)
    ++ " change. --"
--> "-- This is a MINOR change. --"