Documentation on Actors is misleading

[jacobat]

On http://ruby-concurrency.github.io/concurrent-ruby/Concurrent/Actor.html (as linked from https://github.com/ruby-concurrency/concurrent-ruby#features--documentation) the code samples use a terminated method on the actor which does not exist on 0.7.0.

The Wiki mentions (https://github.com/ruby-concurrency/concurrent-ruby/wiki#asynchronous-concurrency) which links to a different page in the docs (http://ruby-concurrency.github.io/concurrent-ruby/Concurrent/Actress.html):

Actress (replacement for the deprecated Actor)

It would be nice if the documentation could somehow reflect reality a bit better.

[jdantonio]

@jacobat Thank you for noting these discrepancies. We were on a fairly tight deadline for the 0.7.0 release because we promised to have it finished before two conferences where this gem was being discussed. We pushed out a lot of code (especially with Actors) but, unfortunately, weren't able to invest as much time in the documentation as we would have liked. We will be updating the documentation soon. In the mean time, we would greatly appreciate any documentation help you and others from the community might be able to give. The wiki is publicly editable and we regularly accept pull requests with documentation updates.

[pitr-ch]

@jacobat thanks for letting us know! I've addressed the most obvious discrepancies in the quick example in #156. I can write with only one hand after an injury but when it's healed I'll be fixing and extending the documentation asap. Please let us know if you notice any other issues, thanks.

[pitr-ch]

#156 merged, keeping open to track need for more actor-doc enhancements.