search

HeinrichApfelmus / threepenny-gui

GUI framework that uses the web browser as a display.
https://heinrichapfelmus.github.io/threepenny-gui/
Other
437 stars 77 forks source link

Do not export `Config` constructor to avoid having to bump the major version when adding a new option field #177

Closed HeinrichApfelmus closed 7 years ago

HeinrichApfelmus commented 7 years ago

I just learned this trick from version 1.2 of the aeson library.

Unfortunately, if we do this, haddock will not document the options fields appropriately. See issue https://github.com/haskell/haddock/issues/3 . As a workaround, we can simply move their documentation into the documentation comment for the data type.

HeinrichApfelmus commented 7 years ago

Implemented in commit 9278d8fdb2208b217e1e686c5bef93774ced413f .