Uploaded image for project: 'Couchbase .NET client library'
  1. Couchbase .NET client library
  2. NCBC-3048

Improve the methods documentation comments in Code and in API reference

    XMLWordPrintable

Details

    • Epic
    • Resolution: Unresolved
    • Major
    • backlog-3.0
    • 3.2.4
    • docs
    • None
    • 1

    Description

      Improve the API reference for SDK 3.x

      for example, in this getAsync method, there are no possible thrown exceptions that can be easily found without digging or experimenting in the code.

      for example

      GetAsync method could return DocumentNotFoundException, but also other exceptions, and there is no way of discovering it.

      https://docs.couchbase.com/sdk-api/couchbase-net-client/api/Couchbase.KeyValue.ICouchbaseCollection.html#Couchbase_KeyValue_ICouchbaseCollection_GetAsync_System_String_Couchbase_KeyValue_GetOptions_

      https://github.com/couchbase/couchbase-net-client/blob/381c0b7c57733565e714cccdd9c3167bba512ece/src/Couchbase/KeyValue/CollectionExtensions.cs#L17

       

       

      Example:

      https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/xmldoc/recommended-tags#exception

       

      Attachments

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

        Activity

          People

            jmorris Jeff Morris
            roi.katz Roi Katz
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

              Created:
              Updated:

              Gerrit Reviews

                There are no open Gerrit changes

                PagerDuty