[
https://issues.apache.org/jira/browse/CASSANDRA-8814?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Philip Thompson updated CASSANDRA-8814:
---------------------------------------
Fix Version/s: 2.1.4
2.0.13
3.0
> Formatting of code blocks in CQL doc in github is a little messed up
> --------------------------------------------------------------------
>
> Key: CASSANDRA-8814
> URL: https://issues.apache.org/jira/browse/CASSANDRA-8814
> Project: Cassandra
> Issue Type: Task
> Components: Documentation & website
> Reporter: Jack Krupansky
> Priority: Minor
> Fix For: 3.0, 2.0.13, 2.1.4
>
>
> Although the html version of the CQL doc on the website looks fine, the
> textile conversion of the source files in github looks a little messed up. In
> particular, the "p." paragraph directives that terminate "bc.." block code
> directives are not properly recognized and then the following text gets
> subsumed into the code block. The directives look fine, as per my read of the
> textile doc, but it appears that the textile converter used by github
> requires that there be a blank line before the "p." directive to end the code
> block. It also requires a space after the dot for "p. ".
> If you go to the github pages for the CQL doc for trunk, 2.1, and 2.0, you
> will see stray "p." directives as well as "\_\_Sample\_\_" text in the code
> blocks, but only where the syntax code block was multiple lines. This is not
> a problem where the "bc." directive is used with a single dot for a single
> line, as opposed to the "bc.." directive used with a double dot for a block
> of lines. Or in the case of the CREATE KEYSPACE section you see all of the
> notes crammed into what should be the "Sample" box.
> See:
> https://github.com/apache/cassandra/blob/trunk/doc/cql3/CQL.textile
> https://github.com/apache/cassandra/blob/cassandra-2.1.2/doc/cql3/CQL.textile
> https://github.com/apache/cassandra/blob/cassandra-2.0.11/doc/cql3/CQL.textile
> This problem ("p." not recognized to terminate a code block unless followed
> by a space and preceded by a blank line) actually occurs for the interactive
> textile formatter as well:
> http://txstyle.org/doc/4/block-code
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
