Documentation language

[pulkitsinghal]

Many times, it is difficult to find what I'm looking for simply because there aren't enough breadcrumbs in the docs ( http://labs.couchbase.com/CouchCocoa/docs/ ) when I perform a search.

Allow me to offer an example ... have a look at this:

prefetch
    If set to YES, the results will include the entire document contents of the associated rows. 

Based on the posts in mobile-couchbase forums, this is directly related to the include_docs functionality from CouchDB but that wording is not used anywhere in the CouchCocoa documentation.

(1) My suggestion would be to consider leaving key clues from the CouchDB vernacular in the CouchCocoa documentation to make it easier to use as a reference, starting with the explanation for prefetch changing to contain the word include_docs in it somewhere.

(2) There is no such thing as documentContents property, this should be fixed in the following:

- (BOOL) prefetch [read, write, assign]

If set to YES, the results will include the entire document contents of the associated rows.

These can be accessed via CouchQueryRow's -documentContents property.

What do you think?

[snej]

Good point — I was trying to make it so CouchCocoa didn't require direct knowledge of the CouchDB API to use, but I can see that this could sometimes make things confusing for people who know/expect the CouchDB terminology.

FYI, you can submit your own documentation improvements via pull request, since the docs are just generated from comments in the header files, using the Doxygen tool.