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

Jonathan Ellis updated CASSANDRA-4879:
--------------------------------------

    Description: 
https://github.com/apache/cassandra/blob/trunk/doc/cql3/CQL.textile doesn't 
include the new create keyspace syntax or the collections. Last time, I updated 
the CQL.textile for Paul Cannon to review. Want me to do it again? 

BNR-like formatting needs to be replaced, right?, because the brackets now have 
literal meaning. I test-applied this custom formatting to commands and it seems 
ok: Uppercase means literal (lowercase nonliteral), italics mean optional, the 
| symbol means OR, ... means repeatable. The ... in italics doesn't strictly 
explain things like nested [...] does, but it's easier on the eyes and loosely 
understandable. Any doubt could be erased by examples, I think. 

  was:
https://github.com/apache/cassandra/blob/trunk/doc/cql3/CQL.textile doesn't 
include the new create keyspace syntax or the collections. Last time, I updated 
the CQL.textile for thePaul to review. Want me to do it again? 

BNR-like formatting needs to be replaced, right?, because the brackets now have 
literal meaning. In the datastax.com docs, I test-applied this custom 
formatting to commands and it seems ok: Uppercase means literal (lowercase 
nonliteral), italics mean optional, the | symbol means OR, ... means 
repeatable. The ... in italics doesn't strictly explain things like nested 
[...] does, but it's easier on the eyes and loosely understandable. Any doubt 
could be erased by examples, I think. 
http://website-staging.dev.datastax.com/docs/1.2/cql_cli/cql/ALTER_COLUMNFAMILY 
and other commands show proposed formatting but no collections stuff yet. 
(username riptano, password joB4aesi4e).

Robin's thinks it's ok, what do you think? 

    
> CQL help in trunk/doc/cql3/CQL.textile outdated
> -----------------------------------------------
>
>                 Key: CASSANDRA-4879
>                 URL: https://issues.apache.org/jira/browse/CASSANDRA-4879
>             Project: Cassandra
>          Issue Type: Bug
>    Affects Versions: 1.2.0 beta 1
>            Reporter: Kristine Hahn
>            Assignee: Sylvain Lebresne
>              Labels: documentation
>
> https://github.com/apache/cassandra/blob/trunk/doc/cql3/CQL.textile doesn't 
> include the new create keyspace syntax or the collections. Last time, I 
> updated the CQL.textile for Paul Cannon to review. Want me to do it again? 
> BNR-like formatting needs to be replaced, right?, because the brackets now 
> have literal meaning. I test-applied this custom formatting to commands and 
> it seems ok: Uppercase means literal (lowercase nonliteral), italics mean 
> optional, the | symbol means OR, ... means repeatable. The ... in italics 
> doesn't strictly explain things like nested [...] does, but it's easier on 
> the eyes and loosely understandable. Any doubt could be erased by examples, I 
> think. 

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

Reply via email to