Uploaded image for project: 'Couchbase PHP client library'
  1. Couchbase PHP client library
  2. PCBC-238

Docs: need examples of API calls, expected usage, expected return values

    Details

    • Type: Bug
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 1.1.2
    • Fix Version/s: 1.2.0
    • Component/s: docs
    • Security Level: Public
    • Labels:
      None
    No reviews matched the request. Check your Options in the drop-down menu of this sections header.

      Activity

      Hide
      trond Trond Norbye added a comment -

      See:
      https://github.com/couchbase/php-ext-couchbase/blob/master/example/couchbase-api.php

      Or provide information on how the pages may be updated...

      Show
      trond Trond Norbye added a comment - See: https://github.com/couchbase/php-ext-couchbase/blob/master/example/couchbase-api.php Or provide information on how the pages may be updated...
      Hide
      kzeller kzeller added a comment -

      See "how to contribute content" for our new docs system:

      https://github.com/couchbaselabs/docs-ng

      As a team member of Couchbase labs you can directly push to stage and let us know if you need help copyediting.

      Show
      kzeller kzeller added a comment - See "how to contribute content" for our new docs system: https://github.com/couchbaselabs/docs-ng As a team member of Couchbase labs you can directly push to stage and let us know if you need help copyediting.
      Hide
      brett19 Brett Lawson added a comment -

      Between the documentations Tutorial, smaller sections, the API Reference (which will be made available shortly) as well as the php sample applications, I think this is more than enough for a user to get a grasp on how to use the various library operations. In regards to error handling, there is a section in the documentation that refers to this and all error codes are documented in the API reference. I don't believe that we should provide specific errors that any particular method returns as this would be frustrating to maintain over time and it is for the best if the user correctly handles all of the errors, even if there is a catch all for most of them.

      Show
      brett19 Brett Lawson added a comment - Between the documentations Tutorial, smaller sections, the API Reference (which will be made available shortly) as well as the php sample applications, I think this is more than enough for a user to get a grasp on how to use the various library operations. In regards to error handling, there is a section in the documentation that refers to this and all error codes are documented in the API reference. I don't believe that we should provide specific errors that any particular method returns as this would be frustrating to maintain over time and it is for the best if the user correctly handles all of the errors, even if there is a catch all for most of them.

        People

        • Assignee:
          brett19 Brett Lawson
          Reporter:
          perry Perry Krug
        • Votes:
          0 Vote for this issue
          Watchers:
          4 Start watching this issue

          Dates

          • Created:
            Updated:
            Resolved:

            Gerrit Reviews

            There are no open Gerrit changes