search

ponylang / ponyc

Pony is an open-source, actor-model, capabilities-secure, high performance programming language
http://www.ponylang.io
BSD 2-Clause "Simplified" License
5.73k stars 415 forks source link

More comments in the example code #3491

Open palash25 opened 4 years ago

palash25 commented 4 years ago

Hi :wave: just started learning Pony a day ago and today I decided to take a look at examples. I found the ring example and started checking out the code, it interested me because I was recently learning about rings in elixir and riak and wanted to see how Pony code differs from it.

I found the file to be lacking in comments explain what the code actually does at a higher level. Since the examples are meant for Pony beginners we should also take into consideration the fact that some pony beginners can be programming (or concurrent programming) beginners too who might not be familiar with what a Ring is.

The fan-in example is a good specimen of a beginner-friendly code example.

I thought that I can raise an issue which can act as a tracker for all such example files and the PRs submitted for them. For example I would like to submit a PR for the ring example adding more comments and anyone else can submit a PR for another example and reference this issue. Since I am also new to Pony I think this will be a great way for me to get familiar with the codebase.

If this sounds good to you folks then let me know, I would love to submit a patch.

SeanTAllen commented 4 years ago

Yes, please feel free to submit improvements that make the examples more beginner friendly. We'd definitely welcome that.

Please keep it to 1 example per PR.