[NCBC-181] Docs do not explain Execute* operation results Created: 14/Dec/12  Updated: 15/Jan/13  Resolved: 15/Jan/13

Status: Closed
Project: Couchbase .NET client library
Component/s: docs
Affects Version/s: 1.2.0
Fix Version/s: 1.2.1

Type: Bug Priority: Major
Reporter: Tim Smith (Inactive) Assignee: John Zablocki (Inactive)
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: 24h
Time Spent: Not Specified
Original Estimate: 24h
Environment: http://www.couchbase.com/docs/couchbase-sdk-net-1.2/api-reference-summary.html


 Description   
I can't find any description of IOperationResult or any of its subclasses in the .NET docs.

I can find a pretty decent description in the wiki, here:

http://www.couchbase.com/wiki/display/couchbase/Couchbase+.NET+Client+Library#Couchbase.NETClientLibrary-%23HandlingFailureswiththeOperationResultsAPI

That info needs to be in the manual. Also, the return value for an operation is critical for understanding what it does. The API summaries elide the return value, and make it difficult to understand the function fully. It's worth the extra screen real estate to specify the return value in all the API summaries.

 Comments   
Comment by John Zablocki (Inactive) [ 10/Jan/13 ]
The API docs have been updated and I've added an appendix on how to work with the results. Pull request sent to docs team.
Comment by John Zablocki (Inactive) [ 15/Jan/13 ]
http://www.couchbase.com/docs/couchbase-sdk-net-1.2/couchbase-sdk-net-operation-results.html
Generated at Mon Sep 01 23:22:27 CDT 2014 using JIRA 5.2.4#845-sha1:c9f4cc41abe72fb236945343a1f485c2c844dac9.