Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Result Documentation #365

Merged
merged 31 commits into from
Apr 11, 2019
Merged

Result Documentation #365

merged 31 commits into from
Apr 11, 2019

Conversation

dalefrancis88
Copy link
Collaborator

This is to add the documentation for Result per #42

Not ready for review, but happy for input

@coveralls
Copy link

coveralls commented Dec 20, 2018

Coverage Status

Coverage remained the same at 100.0% when pulling 915b1c9 on docs/Result into 716e90d on master.

@dalefrancis88
Copy link
Collaborator Author

Hey @evilsoft or @HenriqueLimas I'd love an initial set of 👀 on this. I think everything is ready for review except the tryCatch example which i'll get onto tomorrow, assuming I don't REALLY enjoy new years 😄

Copy link
Owner

@evilsoft evilsoft left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here is a quick pass on the first few sections. Some of the comments apply to most of the other sections.
Will do another review on some more later this week.

docs/src/pages/docs/crocks/Result.md Show resolved Hide resolved
docs/src/pages/docs/crocks/Result.md Outdated Show resolved Hide resolved
docs/src/pages/docs/crocks/Result.md Outdated Show resolved Hide resolved
docs/src/pages/docs/crocks/Result.md Outdated Show resolved Hide resolved
docs/src/pages/docs/crocks/Result.md Outdated Show resolved Hide resolved
docs/src/pages/docs/crocks/Result.md Outdated Show resolved Hide resolved
docs/src/pages/docs/crocks/Result.md Outdated Show resolved Hide resolved
docs/src/pages/docs/crocks/Result.md Outdated Show resolved Hide resolved
docs/src/pages/docs/crocks/Result.md Outdated Show resolved Hide resolved
docs/src/pages/docs/crocks/Result.md Outdated Show resolved Hide resolved
@dalefrancis88
Copy link
Collaborator Author

@evilsoft Thanks for looking at this. I'll get the review items fixed up and the tryCatch examples in :)

@dalefrancis88 dalefrancis88 added this to Needs review in V 0.12.x Feb 26, 2019
@dalefrancis88 dalefrancis88 dismissed evilsoft’s stale review March 1, 2019 06:10

Pending new review

Copy link
Owner

@evilsoft evilsoft left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alright was able to devote a good amount of time to this review.

docs/src/pages/docs/crocks/Result.md Outdated Show resolved Hide resolved
docs/src/pages/docs/crocks/Result.md Outdated Show resolved Hide resolved
docs/src/pages/docs/crocks/Result.md Outdated Show resolved Hide resolved
docs/src/pages/docs/crocks/Result.md Outdated Show resolved Hide resolved
docs/src/pages/docs/crocks/Result.md Outdated Show resolved Hide resolved
docs/src/pages/docs/crocks/Result.md Outdated Show resolved Hide resolved
docs/src/pages/docs/crocks/Result.md Outdated Show resolved Hide resolved
docs/src/pages/docs/crocks/Result.md Outdated Show resolved Hide resolved
docs/src/pages/docs/crocks/Result.md Outdated Show resolved Hide resolved
docs/src/pages/docs/crocks/Result.md Outdated Show resolved Hide resolved
Copy link
Owner

@evilsoft evilsoft left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dalefrancis88 Looks like you got all the stuff I found in that last review.
BUT I found a few more things, but feel 💯 that we can 🚢 🇮🇹 after these things are addressed.

Thanks so much for tackling this. These Sum Types can be very brutal to document.

docs/src/pages/docs/crocks/Result.md Show resolved Hide resolved
docs/src/pages/docs/crocks/Result.md Outdated Show resolved Hide resolved
docs/src/pages/docs/crocks/Result.md Outdated Show resolved Hide resolved
docs/src/pages/docs/crocks/Result.md Outdated Show resolved Hide resolved
docs/src/pages/docs/crocks/Result.md Outdated Show resolved Hide resolved
ensure(isNumber)

// swapWithDefault :: Result e a -> Result String Number
const swapWithDefault =
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still think we need an example that transforms as it swaps instead of using two constants. Thoughts?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've written a different version, hopefully it's a bit better, lmk

docs/src/pages/docs/crocks/Result.md Outdated Show resolved Hide resolved
docs/src/pages/docs/crocks/Result.md Show resolved Hide resolved
docs/src/pages/docs/crocks/Result.md Outdated Show resolved Hide resolved
V 0.12.x automation moved this from Needs review to Reviewer approved Apr 11, 2019
@evilsoft
Copy link
Owner

Think this will do it. Amazing work on this @dalefrancis88!
Thank you so much for your time and dedication getting this through.

image

@evilsoft evilsoft merged commit a98cac3 into master Apr 11, 2019
V 0.12.x automation moved this from Reviewer approved to Done Apr 11, 2019
@evilsoft evilsoft deleted the docs/Result branch April 11, 2019 03:45
@dalefrancis88
Copy link
Collaborator Author

No problem, thanks for your limitless patience :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
V 0.12.x
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants