paldepind / union-type

A small JavaScript library for defining and using union types.
MIT License
477 stars 28 forks source link

Create New Release #59

Open jakesower opened 7 years ago

jakesower commented 7 years ago

The documentation does not match the current state of the module from npm. This has made the documentation confusing for those of us not running master. Specifically, the introduction of nullary constructors caused me some headache when trying to read the documentation. The documentation says to use Maybe.Nothing but that breaks the current release.

Dropping in a new version would be most appreciated! Thanks for your work on this repository.

paldepind commented 7 years ago

I apologize for the confusion. I've just published 0.4.0 on npm. Please check that it fixes your issues :smile:

davidchambers commented 7 years ago

The documentation does not match the current state of the module from npm.

I avoid this problem in the Sanctuary projects by using Transcribe. The comments in the source file always reflect what is on master, while the readme—generated from the source file as part of the automated release process—always reflects the most recently released version.

jakesower commented 7 years ago

Yes, the updated version fixed my issues. Thank you!

@davidchambers That's a good technique that I will keep in mind as I work with code in those projects.

I appreciate the comments from both of you!