Documentation

[trevoke]

Documentation

[Trevoke]

Would http://rubydoc.info/gems/SgfParser/1.0.0/frames satisfy your
need for documentation (that is the link on
http://rubygems.org/gems/SgfParser) ?
I do agree that it is sorely outdated. The comments in the source code
actually are for rdoc - Ruby generation of documentation. This
particular page will be regenerated when I do the next release. Do you
think there should also be this kind of documentation on Github? Or --
how would you like the documentation?

On Mon, Dec 5, 2011 at 02:45, Colin Noga
[email protected]
wrote:

You have some comments in the source, but actual documentation is nil, and the stuff you do have in the README is actually wrong. For example, you pass no args to SGF::Parser.new, but the source calls for a raw string of the read data. Likewise, parser.parse has that argument, but in actuality, should not.

Generally any documentation at all would be nice.

---

Reply to this email directly or view it on GitHub:
#13

[Tempus]

I was not able to find this documentation - I have only just begun using ruby, and was not aware that documentation was primarily stored externally from a gem.

A note in the README somewhere near the top with a link to the rubydocs page should be sufficient, though as well some simple and clear examples in an examples folder for common operations would also be appreciated as time goes on.

[Trevoke]

These are fantastic ideas. Thanks :)