search

socketry / async

An awesome asynchronous event-driven reactor for Ruby.
MIT License
2.04k stars 85 forks source link

Operation: Documentation #12

Closed picatz closed 7 years ago

picatz commented 7 years ago

So, with the branch I just made, I'm attempting to add some inline documentation following the YARD style -- because I think that it's awesome like a possum.

this is an awesome possum

Some Lil Bumps In Da Road

I don't know, like, everything that is going on under the hood for this gem obviously. In general, this is some of my first exposure to IO related concepts. Plus, I get terribly distracted with other things I end up working on ( like a lot of us, I'm sure ).

So, wherever I obviously am falling short on explanations, I'd appreciate you cool cats ( or dogs ) in helping contribute to the documentation effort.

plz

So, please be sure to go over ma' mistakes and help correct them.

Why YardDoc Ahoy?

Because pirates, of course.

ioquatix commented 7 years ago

Sure :)

ioquatix commented 7 years ago

I am okay with YARD, I've used it on some projects before. I'm fine with whatever works for now.

ioquatix commented 7 years ago

Okay, I've squash merged everything from that branch. I've made quite a few improvements too. Thanks for working on this!

ioquatix commented 7 years ago

I'm going to close this issue, as we've merged and improved on everything. However, still looking forward to other improvements :)