[jira] [Commented] (HBASE-15447) Improve javadocs description for Delete methods

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

    [ https://issues.apache.org/jira/browse/HBASE-15447?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15191887#comment-15191887 ] 

stack commented on HBASE-15447:
-------------------------------

Makes sense. Throw up a patch if you have a moment [~wchevreuil]


> Improve javadocs description for Delete methods
> -----------------------------------------------
>
>                 Key: HBASE-15447
>                 URL: https://issues.apache.org/jira/browse/HBASE-15447
>             Project: HBase
>          Issue Type: Improvement
>          Components: documentation
>            Reporter: Wellington Chevreuil
>            Assignee: Wellington Chevreuil
>            Priority: Minor
>
> Current javadoc for Delete operation is a bit confusing. Even though initial section does describe the proper behaviour, where calling delete without specifying timestamp will only delete records from now to the past, this is not as clear in the method specific description
> {noformat}
> public Delete(byte[] row)
> Create a Delete operation for the specified row.
> If no further operations are done, this will delete everything associated with the specified row (all versions of all columns in all families).
> Parameters:
> row - row key
> {noformat}
> The description can lead to the conclusion that all versions will be deleted. But that's not true if a row has a future timestamp. Although this is a very unusual scenario (having a future timestamp), it should still be clarified.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)