evancz / guide.elm-lang.org

My book introducing you to Elm!
https://guide.elm-lang.org/
Other
321 stars 186 forks source link

making a little less confusing the documentation #101

Closed Grummfy closed 6 years ago

Grummfy commented 7 years ago

Hi, I really enjoy tyhe clarity of the documentation, but the example can be less confusiong just by renaming stuff.

Here is an example: https://guide.elm-lang.org/architecture/effects/random.html and the given example http://elm-lang.org/examples/random

=> https://ellie-app.com/39M4FDKfwz5a1/1

So just by renaming some values, we make it more explicit :

After that, we can always said that it's better to have update, init, etc function to be easier to read. But learning with that make confusion possible.

It's just a suggestion, but it can help people to understand faster the given example all along the documentation, so increase the adoption of elm ;) What do you think of this?

process-bot commented 7 years ago

Thanks for the issue! Make sure it satisfies this checklist. My human colleagues will appreciate it!

Here is what to expect next, and if anyone wants to comment, keep these things in mind.

evancz commented 6 years ago

I want to keep it as it is. I like the idea of making it clearer to folks that the function names can be whatever you want, but I think I care more that there is a general culture where folks do things in similar ways, making it easy to read other people's code. Perhaps there is some other way to accomplish the root goal.