search

br1ghtyang / asterixdb

Automatically exported from code.google.com/p/asterixdb
0 stars 0 forks source link

Review the AQL type doc to adjust format from google wiki to markdown #485

Closed GoogleCodeExporter closed 8 years ago

GoogleCodeExporter commented 8 years ago 
The new markdown document should be reviewed to correct their format from 
google wiki to markdown format.

Original issue reported on code.google.com by jarod...@gmail.com on 29 May 2013 at 5:45

GoogleCodeExporter commented 8 years ago

Original comment by westm...@gmail.com on 29 May 2013 at 6:12

GoogleCodeExporter commented 8 years ago 
I think Till has covered most of the format conversion when he created these 
markdown pages. I did some minor update on the AsterixDBDataModel page. 

I am thinking that we may need to create a "AsterixDoc Conventions" in order to 
guide the future document writing. Currently in the AsterixDBDataModel page we 
follows these conventions:
- All AQL builtin types are wrapped as inlined code block, and also capitalize 
the first character.
- To emphasize some strings, use "_*" and "*_" to wrap them (so the strings 
will be wrapped by <em> tag in the generated html)
And probably we need to add more into this list for future reference?

Original comment by jarod...@gmail.com on 30 May 2013 at 7:59

GoogleCodeExporter commented 8 years ago 
Wrt. to the built-in types I'm wondering if it would be better not to 
capitalize them as that might lead to confusion.

What do you think?

Original comment by westm...@gmail.com on 30 May 2013 at 11:50

GoogleCodeExporter commented 8 years ago 
I agree with Till. Users may want to do a copy-and-paste for the type name. I 
have addressed this change, and if no objection, I will merge them back to the 
master.

Original comment by jarod...@gmail.com on 3 Jun 2013 at 2:14

GoogleCodeExporter commented 8 years ago 
I agree we should use lower case to be consistent with the syntax.  @Mike and 
@Vinayak, if you agree, we can finish and close this issue.

Original comment by che...@gmail.com on 3 Jun 2013 at 3:50

GoogleCodeExporter commented 8 years ago

Original comment by jarod...@gmail.com on 3 Jun 2013 at 5:49

GoogleCodeExporter commented 8 years ago 
Jarod, please go ahead to make the changes (using lower case).

Original comment by che...@gmail.com on 3 Jun 2013 at 6:30

GoogleCodeExporter commented 8 years ago

Original comment by jarod...@gmail.com on 4 Jun 2013 at 5:03