[jira] Reopened: (PIG-1182) Pig reference manual does not mention syntax for comments

["David Ciemiewicz (JIRA)" <ji...@apache.org>]

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

David Ciemiewicz reopened PIG-1182:
-----------------------------------


Corinne, not sure what you are so resistant to following the basic principles of documenting ALL syntax, including comments, in the reference manual. If the document is open to the community to edit, I'm more than willing to do the work myself since I have contibuted as a technical writer for programming language reference manuals in my past as well as having been a developer of compilers and software development tools.

Also, I think the passage you sited could use a little work on the English: 

Using Comments in Scripts
If you place Pig Latin statements in a script, the script can include comments.

For multi-line comments use /* .... */
For single line comments use --
/* myscript.pig
My script includes three simple Pig Latin Statements.
*/

A = LOAD 'student' USING PigStorage() AS (name:chararray, age:int, gpa:float); -- load statement
B = FOREACH A GENERATE name;  -- foreach statement
DUMP B;  --dump statement
Case Sensitivity


> Pig reference manual does not mention syntax for comments
> ---------------------------------------------------------
>
>                 Key: PIG-1182
>                 URL: https://issues.apache.org/jira/browse/PIG-1182
>             Project: Pig
>          Issue Type: Bug
>          Components: documentation
>    Affects Versions: 0.5.0
>            Reporter: David Ciemiewicz
>            Assignee: Corinne Chandel
>             Fix For: 0.7.0
>
>
> The Pig 0.5.0 reference manual does not mention how to write comments in your pig code using -- (two dashes).
> http://hadoop.apache.org/pig/docs/r0.5.0/piglatin_reference.html
> Also, does /* */ also work?

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.