[CASSANDRA-4879] CQL help in trunk/doc/cql3/CQL.textile outdated

• Type: Bug
• Status: Resolved
• Priority: Normal
• Resolution: Fixed
• Fix Version/s: 1.2.0 beta 3
• Labels: documentation
• Severity: Normal
• Assignee: Eric Evans
• Reporter: K. B. Hahn

Authors

Eric Evans

Reviewers

Sylvain Lebresne

• Created: 30/Oct/12 20:07
• Updated: 16/Apr/19 09:32
• Resolved: 06/Nov/12 14:14

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.

Issue Links

• is duplicated by: CASSANDRA-4959 CQLSH insert help has typo