You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@pig.apache.org by "David Ciemiewicz (JIRA)" <ji...@apache.org> on 2010/01/08 09:04:54 UTC
[jira] Created: (PIG-1182) Pig reference manual does not mention
syntax for comments
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
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.
[jira] Resolved: (PIG-1182) Pig reference manual does not mention
syntax for comments
Posted by "Corinne Chandel (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/PIG-1182?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Corinne Chandel resolved PIG-1182.
----------------------------------
Resolution: Won't Fix
Pig Latin 1 contains information about comments.
> 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.
[jira] Commented: (PIG-1182) Pig reference manual does not mention
syntax for comments
Posted by "Corinne Chandel (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/PIG-1182?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12835622#action_12835622 ]
Corinne Chandel commented on PIG-1182:
--------------------------------------
In pig 0.6.0, Pig User and Pig Latin docs renamed Pig Latin 1 and Pig Latin 2 (the 2 docs should have been named this way when I split them up - sorry for confusion).
Pig Latin 1 and Pig Latin 2 docs have statements saying docs should be used together.
Pig Latin 1 doc includes the information about comments.
> 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.
[jira] Commented: (PIG-1182) Pig reference manual does not mention
syntax for comments
Posted by "Olga Natkovich (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/PIG-1182?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12836055#action_12836055 ]
Olga Natkovich commented on PIG-1182:
-------------------------------------
Ciemo,
There is a reason why Corinne created to sections of the document. A single document was just too large so it was hard to manage changes and even to load it takes some time.
If I understand correctly, the real issue that you are pointing out is that it is hard to find specific information that you are looking for quickly. Traditionally indices are used for this purpose and pig documentation does not have one.
Short term, Corinne does not have time to work on it due to other commitment. If you or other users would like to help with that, that would certainly be appreciated.
> 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.
[jira] Updated: (PIG-1182) Pig reference manual does not mention
syntax for comments
Posted by "Olga Natkovich (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/PIG-1182?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Olga Natkovich updated PIG-1182:
--------------------------------
Fix Version/s: (was: 0.7.0)
Assignee: (was: Corinne Chandel)
> 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
>
> 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.
[jira] Resolved: (PIG-1182) Pig reference manual does not mention
syntax for comments
Posted by "Olga Natkovich (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/PIG-1182?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Olga Natkovich resolved PIG-1182.
---------------------------------
Resolution: Fixed
Closing. If we do want to do an comprehansive index, please, create a separate JIRA
> 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
>
> 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.
[jira] Assigned: (PIG-1182) Pig reference manual does not mention
syntax for comments
Posted by "Olga Natkovich (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/PIG-1182?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Olga Natkovich reassigned PIG-1182:
-----------------------------------
Assignee: Corinne Chandel
> 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.
[jira] Reopened: (PIG-1182) Pig reference manual does not mention
syntax for comments
Posted by "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.
[jira] Commented: (PIG-1182) Pig reference manual does not mention
syntax for comments
Posted by "Corinne Chandel (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/PIG-1182?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12798063#action_12798063 ]
Corinne Chandel commented on PIG-1182:
--------------------------------------
Actually, the Pig docs do mention how to form comments.
The section was moved to the Pig Users guide when I split up the Pig Latin Reference manual.
Both -- and /* */ are shown.
http://hadoop.apache.org/pig/docs/r0.5.0/piglatin_users.html#Using+Comments+in+Scripts
So, I'm not sure where you made the correction.
Thanks/C
> 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.
[jira] Updated: (PIG-1182) Pig reference manual does not mention
syntax for comments
Posted by "Olga Natkovich (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/PIG-1182?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Olga Natkovich updated PIG-1182:
--------------------------------
Fix Version/s: 0.7.0
> 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.
[jira] Commented: (PIG-1182) Pig reference manual does not mention
syntax for comments
Posted by "David Ciemiewicz (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/PIG-1182?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12798128#action_12798128 ]
David Ciemiewicz commented on PIG-1182:
---------------------------------------
Corinne, I made no changes.
I'm pointing out that it is an omission to not have the comment syntax documented in the reference manual.
Reference manuals for programming languages SHOULD ALWAYS have information on ALL syntax including comment syntax.
Once you are done with learning things in the User's Guide, most of the time programmer's just go back to the Reference Manual for quick look up of information and syntax.
So the documentation on comment syntax should be in BOTH the User's Guide AND the Reference Manual.
> 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.