compiler icon indicating copy to clipboard operation
compiler copied to clipboard

exposing variants → major version; should be minor

Open lue-bird opened this issue 2 years ago • 1 comments

If a package exposes variants of a type that did not expose its variants in a previous version, it will be marked as a major change, even though it doesn't remove but only add API → minor change.

SSCCE

module Data exposing (Data)
{-| -}
{-| -}
type Data
    = Data

changed to

module Data exposing (Data(..))
{-| -}
{-| -}
type Data
    = Data

then

elm diff

prints out

This is a MAJOR change.

---- N - MAJOR ----

    Changed:
      - type Data 
      + type Data  = Data

docs json output

elm make --docs=....json

previous version

{"name":"Data","comment":" \n","args":[],"cases":[]}

new version

{"name":"Data","comment":" \n","args":[],"cases":[["Data"]]}
  • Elm: 0.19.1
  • Operating System: Ubuntu 22.04.1 LTS

lue-bird avatar Dec 19 '22 22:12 lue-bird

Thanks for reporting this! To set expectations:

  • Issues are reviewed in batches, so it can take some time to get a response.
  • Ask questions in a community forum. You will get an answer quicker that way!
  • If you experience something similar, open a new issue. We like duplicates.

Finally, please be patient with the core team. They are trying their best with limited resources.

github-actions[bot] avatar Dec 19 '22 22:12 github-actions[bot]