Documentation

[Peter Hunsberger]

I've been pondering your question about what kinds of documentation would help the most and I think the one thing that would have helped me the most would have been a good set of ScalaDoc (JavaDoc) across the Sangria API.  This might have to be coupled with some more attention to package visibility though I suspect most of the things that aren't explicitly private are needed at the public API level.  To be really useful the ScalaDoc would have to include usage examples and complete parameter and return value descriptions.  Don't know if it would also point to your other documentation or whether your other documentation would eventually start to point to the ScalaDoc, but eitehr way, hope you might consider this.

[Oleg Ilyenko]

Hi Peter

Thanks for pointing this out! Definitely, I think I need to take some time and add some scaladoc. It's a quite time-consuming task, so I would really appreciate help with this one as well.

It would also help if you could analyze and share which parts of API need scaladocs the most. It is not a one-time affair, so these most important places can be the best candidates for a first iteration.

Cheers,

Oleg