[NCBC-78] Enhance discussion of return codes/values Created: 26/Jun/12  Updated: 31/Jan/14  Resolved: 31/Jan/14

Status: Resolved
Project: Couchbase .NET client library
Component/s: docs
Affects Version/s: 1.1.6
Fix Version/s: 1.3.2

Type: Bug Priority: Blocker
Reporter: Perry Krug Assignee: Jeff Morris
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Attachments: Microsoft Word error-code-checking.docx    
Issue Links:
Duplicate
is duplicated by NCBC-249 We need documentation that explains h... Resolved

 Description   
Given the comments on this page: http://www.couchbase.com/docs/couchbase-sdk-net-1.1/couchbase-sdk-net-retrieve-set.html

Perhaps there can be a section on the possible return codes/values, what they mean, when they might happen, and how to deal with them?

 Comments   
Comment by Mark Nunberg [ 22/Nov/12 ]
This is a must-have for SDK testing. It is very difficult to determine failure types and severities without knowing what types of errors, exception classes, or such to expect.

At the very least, there should be standard return codes (in a well-defined location) for memcached error codes.
Comment by Jeff Morris [ 30/Jan/14 ]
Possible dupe: http://www.couchbase.com/issues/browse/NCBC-249#comment-77768
Comment by Jeff Morris [ 30/Jan/14 ]
Proposed amendment to documentation. Please review and provide feedback.
Comment by Perry Krug [ 31/Jan/14 ]
Thanks Jeff, this is a great start and well explained. I think it fits very nicely into our documentation, and just needs to be linked to from a variety of places in order to help people find it.

I think it would also be helpful to see some examples of handling of some of the more common error codes
Comment by Jeff Morris [ 31/Jan/14 ]
Great. I think we should consider this a "work in progress" and do a bit each month. Probably the best way to approach this is to create separate, specific tickets addressing documentation that we are lacking and ad them to the backlog. I'll pull one or two into each monthly "sprint" that I do for a release. From a workflow perspective, I like jira tickets to have a short lifespan...makes me feel more productive ;)
Comment by Jeff Morris [ 31/Jan/14 ]
This will sit underneath: http://docs.couchbase.com/couchbase-sdk-net-1.3/#appendix-working-with-operation-results

Note that it's no longer listed as an "appendix" but as a section: "Working with Operation Results and Error Codes"

Will be published with release notes for 1.3.2 on Tuesday.
Generated at Fri Aug 29 17:12:30 CDT 2014 using JIRA 5.2.4#845-sha1:c9f4cc41abe72fb236945343a1f485c2c844dac9.