search

hemanth / functional-programming-jargon

Jargon from the functional programming world in simple terms!
http://git.io/fp-jargons
MIT License
18.58k stars 1.02k forks source link

docs: Consistently use Option (instead of Optional) to refer to this data type #189

Closed hekmekk closed 5 years ago

hekmekk commented 5 years ago

This drops the use of Optional to refer to the Option type for consistency (and removes trailing whitespaces).

jethrolarson commented 5 years ago

Thanks! Btw looking at the affected sentence, it looks to have some grammar problems but that's not your fault

On Thu, Oct 18, 2018, 3:06 AM Rea Sand notifications@github.com wrote:

This drops the use of Optional to refer to the Option type for consistency (and removes trailing whitespaces).

You can view, comment on, or merge this pull request online at:

https://github.com/hemanth/functional-programming-jargon/pull/189 Commit Summary

  • docs: consistently use Option instead of Optional
  • fix: drop trailing whitespace

File Changes

Patch Links:

- https://github.com/hemanth/functional-programming-jargon/pull/189.patch

https://github.com/hemanth/functional-programming-jargon/pull/189.diff

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/hemanth/functional-programming-jargon/pull/189, or mute the thread https://github.com/notifications/unsubscribe-auth/AAB-4PZ29Hy01Gz4jd4oYsj808mx34DCks5umFK8gaJpZM4XtGde .

hekmekk commented 5 years ago

Going through that section (Totality), it's not only grammar @jethrolarson. I have a few problems with it. It also seems necessary to establish what a function is. That section basically introduces function but misses some important points. Also slight inaccuracies have crept into the entire document. Things like "a function [...] is said to have a side effect" is inaccurate – if it has a side effect, it's not a function. Similarly with purity: Calling a function pure is redundant. If it isn't pure, it's not a function either.

I'm not sure how to deal with these issues. But I feel like we should make clear what a function is and how purity and side effects are properties that methods/procedures and the likes can possess.

jethrolarson commented 5 years ago

I agree. That section could use more than a little cleanup. You're welcome to take a crack at it. Just remember that the first goal of this project is to be approachable so if we have to use a little hand waving to make it so these definitions are understandable by normal JavaScript developers we should do so. This PR is mergeable as is though so you can follow up in another if you're inclined.

hekmekk commented 5 years ago

Right, I don't want to mess with the primary goal of this document. Will give it a shot :) Thanks for your feedback!

jethrolarson commented 5 years ago

Btw I'm happy to help with the js as I have time

On Sat, Oct 20, 2018, 4:39 AM Rea Sand notifications@github.com wrote:

Right, I don't want to mess with the primary goal of this document. Will give it a shot :) Thanks for your feedback!

— You are receiving this because you modified the open/close state.

Reply to this email directly, view it on GitHub https://github.com/hemanth/functional-programming-jargon/pull/189#issuecomment-431572881, or mute the thread https://github.com/notifications/unsubscribe-auth/AAB-4NKK61AkScTPDOC17Gtto5emMK-5ks5umwuIgaJpZM4XtGde .

hekmekk commented 5 years ago

Thanks :+1: , will work on it in a fb in my spare time.