Couchbase Java Client

add showtype-options to documentation

Details

  • Type: Improvement Improvement
  • Status: Reopened Reopened
  • Priority: Major Major
  • Resolution: Unresolved
  • Affects Version/s: None
  • Fix Version/s: 1.1.7
  • Component/s: docs
  • Security Level: Public
  • Labels:
    None

Description

Many of the Java docs should show the type in the options summary.

Activity

Descending order - Click to sort in ascending order
Hide
Permalink
Matt Ingenthron added a comment - - edited
If you look at the docs, there are many places where we have types that are returned, but we don't sufficiently describe those types. For example:
http://www.couchbase.com/docs/couchbase-sdk-java-1.1/couchbase-sdk-java-set-add.html#table-couchbase-sdk_java_add

It mentions the OperationFuture, but nowhere really tell how to use it (to my knowledge).

You should be able to work with MC on the right way to fix these.
Show
Matt Ingenthron added a comment - - edited If you look at the docs, there are many places where we have types that are returned, but we don't sufficiently describe those types. For example: http://www.couchbase.com/docs/couchbase-sdk-java-1.1/couchbase-sdk-java-set-add.html#table-couchbase-sdk_java_add It mentions the OperationFuture, but nowhere really tell how to use it (to my knowledge). You should be able to work with MC on the right way to fix these.
Hide
Permalink
Michael Nitschinger added a comment -
Can you give me a quick example on what you mean? Reassign it back to me then and I'll fix it!
Show
Michael Nitschinger added a comment - Can you give me a quick example on what you mean? Reassign it back to me then and I'll fix it!

People

  • Assignee:
    Michael Nitschinger
    Reporter:
    Matt Ingenthron
Vote (0)
Watch (0)

Dates

  • Created:
    Updated: