Uploaded image for project: 'Couchbase C client library libcouchbase'
  1. Couchbase C client library libcouchbase
  2. CCBC-1097

[DOCS] Update Error Handling Documentation for libcouchbase

    XMLWordPrintable

Details

    • New Feature
    • Status: Resolved
    • Major
    • Resolution: Fixed
    • None
    • 3.2.1
    • docs
    • 1
    • SDK40: Verif2,Bugs,Docs,Retry, SDK42: Verif2,Retr,RTO,Circuit, SDK44: βref(1),CombT,Migration, SDK48: βref(2),CombT,Migr., SDK50: βref(2),CombT,Migr., SDK52: B/GA, Doc:Migr/Stngs/Co, SDK1: GA and Priority List, SDK24: Txnλ+Func,TxnFormer,CoC, SDK26: TxnFunc2,TxnFormer,KS, SDK28: Txn Loop/Rb,PfQueryColl, SDK32: QueryCollections, SDK30: Connect,Txns

    Description

      Update error handling to match plans with sdk3 sdk-rfc.

      SDK 3.0: Error Handling RFC:
      https://docs.google.com/document/d/1oWyuPIxmErNh9BerU3UYqpFQPnmg9Yl8h7oNJzCVVYM

      Attachments

        Issue Links

          No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            Ray: while you're in lcb mode, perhaps you can help with this ticket that has been behind for some time? Perhaps the goal would be to spend a half day making significant improvements, then file issues for what's not done relative to what's intended.

            ingenthr Matt Ingenthron added a comment - Ray: while you're in lcb mode, perhaps you can help with this ticket that has been behind for some time? Perhaps the goal would be to spend a half day making significant improvements, then file issues for what's not done relative to what's intended.
            ray.cardillo Ray Cardillo added a comment -

            Matt Ingenthron I spent some time reviewing and editing to provide at least one increment of improvements that is better than what is currently there. However, we'll need to discuss how to document what's called for in the RFC versus what's available in LCB.

            PR:
            https://github.com/couchbase/docs-sdk-c/pull/106/files

            Note that there are two main changes here:

            1. The "Handling Errors" page is updated with more context to help communicate strategies and what constructs are available in LCB to help obtain additional information and implement various application specific error handling strategies.
            2. Converted version references and special links to global attributes and contributed "one round" of refactoring of related references that were more obvious. For now, I avoided older references or special cases that seemed to need more review, but I have those changes stashed if requested.
            ray.cardillo Ray Cardillo added a comment - Matt Ingenthron I spent some time reviewing and editing to provide at least one increment of improvements that is better than what is currently there. However, we'll need to discuss how to document what's called for in the RFC versus what's available in LCB. PR: https://github.com/couchbase/docs-sdk-c/pull/106/files Note that there are two main changes here: The "Handling Errors" page is updated with more context to help communicate strategies and what constructs are available in LCB to help obtain additional information and implement various application specific error handling strategies. Converted version references and special links to global attributes and contributed "one round" of refactoring of related references that were more obvious. For now, I avoided older references or special cases that seemed to need more review, but I have those changes stashed if requested.

            People

              ray.cardillo Ray Cardillo
              ingenthr Matt Ingenthron
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Gerrit Reviews

                  There are no open Gerrit changes

                  PagerDuty