[jira] [Updated] (HBASE-16000) Table#checkAndPut() docs are too vague

["Guanghao Zhang (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/HBASE-16000?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Guanghao Zhang updated HBASE-16000:
-----------------------------------
    Attachment: HBASE-16000.master.001.patch

> Table#checkAndPut() docs are too vague
> --------------------------------------
>
>                 Key: HBASE-16000
>                 URL: https://issues.apache.org/jira/browse/HBASE-16000
>             Project: HBase
>          Issue Type: Bug
>          Components: documentation
>            Reporter: Nick Dimiduk
>            Assignee: Csaba Skrabak
>            Priority: Minor
>              Labels: beginner, beginners
>             Fix For: 2.0.0
>
>         Attachments: HBASE-16000.master.001.patch, hbase-16000.patch
>
>
> The docs for our CAS operations that accept a {{CompareOp}} are too vague. They're copied from the part that implies {{CompareOp.EQUAL}}, which means they don't tell you how your op, the provided {{value}}, and any present value are compared.
> Only by digging into HRegion.java can I see that the operation is, for example with CompareOp.GREATER, we get {{value.compareTo(existingKeyValue) > 0}}. Javadocs should be explicit about the order of operands.



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)