Changelog entry for v1.4.100.0 isn't helpful

[hasufell]

In GitLab by @sjakobi on Jul 16, 2022, 24:05

https://hackage.haskell.org/package/filepath-1.4.100.0/changelog

Implementation of the Abstract FilePath Proposal in user-space as a separate type.

• The linked GHC wiki entry provides some context, but it doesn't provide any information about the actual implementation. The latest edit of that wiki page was in 2019!

• What is "in user-space" supposed to mean?

As a user, I'd expect the changelog to provide information on the API changes and ideally a suggestion on how I should respond, i.e. a migration guide.

[hasufell]

In GitLab by @sjakobi on Jul 16, 2022, 24:06

Congrats on the release though! :thumbsup:

[hasufell]

In GitLab by @maerwald on Jul 16, 2022, 24:07

I can add the blog post to the changelog entry: https://hasufell.github.io/posts/2022-06-29-fixing-haskell-filepaths.html

That explains everything.

I don't want to duplicate all that information.

[hasufell]

In GitLab by @maerwald on Jul 16, 2022, 24:10

https://gitlab.haskell.org/haskell/filepath/-/blob/master/changelog.md#141000-july-2022

Don't think I can update the changelog in-place on hackage though.

[hasufell]

In GitLab by @maerwald on Jul 17, 2022, 04:03

I made a revision, which at least changes the top level description with links to blog and examples: https://hackage.haskell.org/package/filepath-1.4.100.0/revisions/