ponylang / pony-tutorial

:horse: Tutorial for the Pony programming language
http://tutorial.ponylang.io
BSD 2-Clause "Simplified" License
310 stars 111 forks source link

Type Aliases section uses non-introduced sugar #482

Closed maxtremblay closed 3 years ago

maxtremblay commented 3 years ago

Hello.

When reading the Type Aliases section, I was confused by the 'apply' function, which then disappear in other examples.

I would suggest to either add a small explanation that there is some sugar involve in those examples, or use different and more explicit function names.

rhagenson commented 3 years ago

@maxtremblay I agree. The organization of the Tutorial can sometimes lead to situations like this where a concept is shown before it is detailed later.

I think the best route forward in this would be to make a change to the text just above

You can also declare constants like in C or Go like this,

to

You can also declare constants like in C or Go, making use of apply (which will be discussed further in Sugar)

Would this change have avoided your confusion? If so, would you like to submit a PR for this fix?

maxtremblay commented 3 years ago

Yes, the PR is there #483.

rhagenson commented 3 years ago

Closed by #483

@maxtremblay If you find any other oversights or errors while reading the Tutorial, please let us know. If something does not make sense, please reach out on our community Zulip.