[
https://issues.apache.org/jira/browse/HBASE-12049?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14154236#comment-14154236
]
Misty Stanley-Jones commented on HBASE-12049:
---------------------------------------------
This is a good improvement. Here is some feedback:
Please don't skip articles (a, an, the):
s/If "hbase.online..."/If the "hbase.online..."
s/then table/then the table
Also, "then table must be disabled else need not be disabled" reads like a
shell script. How about something like "then the table must be disabled. If
h.o.s.u.enable is set to true, tables can be altered without disabling them
first." Also, do you need to mention any potential risk to enabling it?
Maybe "You can use the alter command to add, modify, or delete column families
or change table configuration options."
s/similarly to create/in a similar way as the create command
s/column family spec/the column family specification
s/dictionary with NAME attribute/dictionary with the NAME attribute
s/described on the main help command output/described in the output of the
'help' command, with no arguments.
I don't see a need to be extremely compact in help text. Does that make sense?
> Help for alter command is a bit confusing
> -----------------------------------------
>
> Key: HBASE-12049
> URL: https://issues.apache.org/jira/browse/HBASE-12049
> Project: HBase
> Issue Type: Improvement
> Components: documentation, shell
> Affects Versions: 0.98.5
> Reporter: Ashish Singhi
> Assignee: Ashish Singhi
> Priority: Trivial
> Labels: shell
> Attachments: HBASE-12049.patch
>
>
> The help message shown for alter command is a bit confusing.
> A part of current help message
> {code}
> Here is some help for this command:
> Alter a table. Depending on the HBase setting
> ("hbase.online.schema.update.enable"),
> the table must be disabled or not to be altered (see help 'disable').
> You can add/modify/delete column families, as well as change table
> configuration. Column families work similarly to create; column family
> spec can either be a name string, or a dictionary with NAME attribute.
> Dictionaries are described on the main help command output.
> {code}
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
