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

Update the documentation to show when a parameter is a copy or a reference

    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

      Description

      When I look at the PHP core documentation I see when a parameter is a reference or not. (so we should review all our function documentation)

      For example if you look at:
      http://www.php.net/sort

      Not only I know the type but also when it is a reference it is mentionned as &$array

      I think we should do the same in our documentation, when I see our API with cas, for example:
      http://www.couchbase.com/docs/couchbase-sdk-php-1.1/api-reference-retrieve-get.html#table-couchbase-sdk_php_get

      it is not clear to me.

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

        Activity

        tgrall Tug Grall (Inactive) created issue -
        tgrall Tug Grall (Inactive) made changes -
        Field Original Value New Value
        Summary Update the documentation to show when a parameter is a copy or reference Update the documentation to show when a parameter is a copy or a reference
        ingenthr Matt Ingenthron made changes -
        Assignee Matt Ingenthron [ ingenthr ] Brett Lawson [ brett19 ]
        Fix Version/s .next [ 11022 ]
        brett19 Brett Lawson made changes -
        Status Open [ 1 ] Resolved [ 5 ]
        Resolution Fixed [ 1 ]
        brett19 Brett Lawson made changes -
        Workflow jira [ 23681 ] Couchbase SDK Workflow [ 44388 ]

          People

          • Assignee:
            brett19 Brett Lawson
            Reporter:
            tgrall Tug Grall (Inactive)
          • Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Gerrit Reviews

              There are no open Gerrit changes