search

louismullie / treat

Natural language processing framework for Ruby.
Other
1.36k stars 128 forks source link

Improve documentation #36

Open nyarly opened 11 years ago

nyarly commented 11 years ago

While it's nice to see "you can do this" (e.g. sentance(word("..."))), the docs don't make it clear what I should expect to happen. Right after introducing building, it'd be a good place to talk about visualizations and include demos.

The traversal docs could really stand to be expanded - the example from issue #35 would be useful, if expanded with an example tree and #=> comments about what's yielded.

louismullie commented 11 years ago

I'll add examples of DOT tree visualizations after building entities. Hopefully that will make it clearer!

louismullie commented 11 years ago

I added DOT tree visualizations. Next step is to add documentation on iteration in the manual.

louismullie commented 11 years ago

Note to self: also need to add documentation on the new Builder object.

seyhunak commented 11 years ago

+1

x44x45x41x4E commented 9 years ago

+1