How to guide users of your API
This post has been imported from my previous blog. I did my best to parse XML properly, but it might have some errors.
If you find one, send a Pull Request.
After winter holidays it was time to get back to the reality and to make up for the pleanty of unread posts in my reader. One of the read posts was Christopher Bennage’s entry about RavenDB API. The main problem with A PI was that it allows calling every Linq extension method on the Raven session. Even, the unwanted one - ToList. Christoper’s proposal is to provide an obsolete ToList method, which accepts the Raven query interface, and by being obsolete informs about the best way of getting a list of objects.
Simple, nice, powerful.
