You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@hbase.apache.org by "Jonathan Gray (JIRA)" <ji...@apache.org> on 2009/02/03 00:59:59 UTC
[jira] Created: (HBASE-1176) Javadocs in HBA should be clear about
which functions are asynchronous and which are synchronous
Javadocs in HBA should be clear about which functions are asynchronous and which are synchronous
------------------------------------------------------------------------------------------------
Key: HBASE-1176
URL: https://issues.apache.org/jira/browse/HBASE-1176
Project: Hadoop HBase
Issue Type: Improvement
Components: client
Affects Versions: 0.19.0
Reporter: Jonathan Gray
Priority: Minor
Fix For: 0.19.1, 0.20.0
Since we don't name all of our functions as sync/async, we should at least be explicit in javadoc about the behavior of each.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (HBASE-1176) Javadocs in HBA should be clear about
which functions are asynchronous and which are synchronous
Posted by "Evgeny Ryabitskiy (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HBASE-1176?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Evgeny Ryabitskiy updated HBASE-1176:
-------------------------------------
Attachment: HBASE-1176.patch
> Javadocs in HBA should be clear about which functions are asynchronous and which are synchronous
> ------------------------------------------------------------------------------------------------
>
> Key: HBASE-1176
> URL: https://issues.apache.org/jira/browse/HBASE-1176
> Project: Hadoop HBase
> Issue Type: Improvement
> Components: client
> Affects Versions: 0.19.0
> Reporter: Jonathan Gray
> Assignee: Evgeny Ryabitskiy
> Priority: Minor
> Fix For: 0.20.0
>
> Attachments: HBASE-1176.patch
>
>
> Since we don't name all of our functions as sync/async, we should at least be explicit in javadoc about the behavior of each.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Resolved: (HBASE-1176) Javadocs in HBA should be clear about
which functions are asynchronous and which are synchronous
Posted by "stack (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HBASE-1176?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
stack resolved HBASE-1176.
--------------------------
Resolution: Fixed
Resolved. Thanks for the patch Evgeny. FYI, patch revisions should get a '-v2' or some such suffix rather than replace the original. Also, short note on difference between old version and new helps. Good stuff E.
> Javadocs in HBA should be clear about which functions are asynchronous and which are synchronous
> ------------------------------------------------------------------------------------------------
>
> Key: HBASE-1176
> URL: https://issues.apache.org/jira/browse/HBASE-1176
> Project: Hadoop HBase
> Issue Type: Improvement
> Components: client
> Affects Versions: 0.19.0
> Reporter: Jonathan Gray
> Assignee: Evgeny Ryabitskiy
> Priority: Minor
> Fix For: 0.20.0
>
> Attachments: HBASE-1176.patch
>
>
> Since we don't name all of our functions as sync/async, we should at least be explicit in javadoc about the behavior of each.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (HBASE-1176) Javadocs in HBA should be clear about
which functions are asynchronous and which are synchronous
Posted by "Evgeny Ryabitskiy (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HBASE-1176?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Evgeny Ryabitskiy updated HBASE-1176:
-------------------------------------
Attachment: HBASE-1176.patch
Added javadoc for all operations, like:
/**
Creates a new table
Synchronous operation.
....
> Javadocs in HBA should be clear about which functions are asynchronous and which are synchronous
> ------------------------------------------------------------------------------------------------
>
> Key: HBASE-1176
> URL: https://issues.apache.org/jira/browse/HBASE-1176
> Project: Hadoop HBase
> Issue Type: Improvement
> Components: client
> Affects Versions: 0.19.0
> Reporter: Jonathan Gray
> Assignee: Evgeny Ryabitskiy
> Priority: Minor
> Fix For: 0.20.0
>
> Attachments: HBASE-1176.patch
>
>
> Since we don't name all of our functions as sync/async, we should at least be explicit in javadoc about the behavior of each.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Assigned: (HBASE-1176) Javadocs in HBA should be clear about
which functions are asynchronous and which are synchronous
Posted by "Evgeny Ryabitskiy (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HBASE-1176?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Evgeny Ryabitskiy reassigned HBASE-1176:
----------------------------------------
Assignee: Evgeny Ryabitskiy
> Javadocs in HBA should be clear about which functions are asynchronous and which are synchronous
> ------------------------------------------------------------------------------------------------
>
> Key: HBASE-1176
> URL: https://issues.apache.org/jira/browse/HBASE-1176
> Project: Hadoop HBase
> Issue Type: Improvement
> Components: client
> Affects Versions: 0.19.0
> Reporter: Jonathan Gray
> Assignee: Evgeny Ryabitskiy
> Priority: Minor
> Fix For: 0.20.0
>
>
> Since we don't name all of our functions as sync/async, we should at least be explicit in javadoc about the behavior of each.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (HBASE-1176) Javadocs in HBA should be clear about
which functions are asynchronous and which are synchronous
Posted by "Jonathan Gray (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HBASE-1176?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Jonathan Gray updated HBASE-1176:
---------------------------------
Fix Version/s: (was: 0.19.1)
Fix for 0.20.0
> Javadocs in HBA should be clear about which functions are asynchronous and which are synchronous
> ------------------------------------------------------------------------------------------------
>
> Key: HBASE-1176
> URL: https://issues.apache.org/jira/browse/HBASE-1176
> Project: Hadoop HBase
> Issue Type: Improvement
> Components: client
> Affects Versions: 0.19.0
> Reporter: Jonathan Gray
> Priority: Minor
> Fix For: 0.20.0
>
>
> Since we don't name all of our functions as sync/async, we should at least be explicit in javadoc about the behavior of each.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (HBASE-1176) Javadocs in HBA should be clear
about which functions are asynchronous and which are synchronous
Posted by "stack (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HBASE-1176?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12701818#action_12701818 ]
stack commented on HBASE-1176:
------------------------------
Looks great Evgeny.
One thing, please add period after first sentence otherwise "Creates a new table" and "Synchronous operation" are run together in javadoc (try it and see yourself "ant javadoc"). If you add period, the method synopsis will be "Creates a new table" rather than "Creates a new table Synchronous operation"
> Javadocs in HBA should be clear about which functions are asynchronous and which are synchronous
> ------------------------------------------------------------------------------------------------
>
> Key: HBASE-1176
> URL: https://issues.apache.org/jira/browse/HBASE-1176
> Project: Hadoop HBase
> Issue Type: Improvement
> Components: client
> Affects Versions: 0.19.0
> Reporter: Jonathan Gray
> Assignee: Evgeny Ryabitskiy
> Priority: Minor
> Fix For: 0.20.0
>
> Attachments: HBASE-1176.patch
>
>
> Since we don't name all of our functions as sync/async, we should at least be explicit in javadoc about the behavior of each.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (HBASE-1176) Javadocs in HBA should be clear about
which functions are asynchronous and which are synchronous
Posted by "Evgeny Ryabitskiy (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HBASE-1176?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Evgeny Ryabitskiy updated HBASE-1176:
-------------------------------------
Attachment: (was: HBASE-1176.patch)
> Javadocs in HBA should be clear about which functions are asynchronous and which are synchronous
> ------------------------------------------------------------------------------------------------
>
> Key: HBASE-1176
> URL: https://issues.apache.org/jira/browse/HBASE-1176
> Project: Hadoop HBase
> Issue Type: Improvement
> Components: client
> Affects Versions: 0.19.0
> Reporter: Jonathan Gray
> Assignee: Evgeny Ryabitskiy
> Priority: Minor
> Fix For: 0.20.0
>
> Attachments: HBASE-1176.patch
>
>
> Since we don't name all of our functions as sync/async, we should at least be explicit in javadoc about the behavior of each.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.