Uploaded image for project: 'Couchbase Lite'
  1. Couchbase Lite
  2. CBL-2546

CBLError description is missing

    XMLWordPrintable

Details

    • Improvement
    • Resolution: Fixed
    • Critical
    • 3.0
    • 3.0
    • iOS
    • Security Level: Public
    • None
    • Jay 60
    • 3

    Description

      Following up on a broader requirement/initiative to improve documentation of our error codes across all products.
      Assuming I am looking at the right place, I have the following observations/feedback

      Ideally, the goal of the initiative is to document error code, a brief description and brief remedial action.

      In most cases on CBL, what needs to be done is self explanatory based on description. So it would be great to add missing the description consistently

      The plan is to add direct link from our docs pages (under troubleshooting section)
      If I should be looking elsewhere for error code documentation, let me know.

      Sample:
      Just equivalent of https://docs.couchbase.com/mobile/3.0.0-beta02/couchbase-lite-net/api/Couchbase.Lite.CouchbaseLiteError.html

      Attachments

        Issue Links

          Activity

            People

              Jayahari.Vavachan Jay Vavachan
              Jayahari.Vavachan Jay Vavachan
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                PagerDuty