You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@parquet.apache.org by "ASF GitHub Bot (JIRA)" <ji...@apache.org> on 2019/06/11 15:54:00 UTC

[jira] [Commented] (PARQUET-1593) Replace the example usage in parquet-cli's help message with an actually existent subcommand

    [ https://issues.apache.org/jira/browse/PARQUET-1593?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16861160#comment-16861160 ] 

ASF GitHub Bot commented on PARQUET-1593:
-----------------------------------------

sekikn commented on pull request #646: PARQUET-1593: Improve parquet-cli's example usage
URL: https://github.com/apache/parquet-mr/pull/646
 
 
   The following description is a bit weird since there's no command
   called "create" actually. This PR replaces the subcommand with an
   actually existent one.
   
   ```
     Examples:
   
       # print information for create
       parquet help create
   ```
   
   Make sure you have checked _all_ steps below.
   
   ### Jira
   
   - [x] My PR addresses the following [Parquet Jira](https://issues.apache.org/jira/browse/PARQUET/) issues and references them in the PR title. For example, "PARQUET-1234: My Parquet PR"
     - https://issues.apache.org/jira/browse/PARQUET-1593
     - In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
   
   ### Tests
   
   - [x] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
   
   I think no additional test is required since this PR only changes the help message and its implementation is simple and straightforward. I ran the revised version manually and confirmed that it worked as expected.
   
   ### Commits
   
   - [x] My commits all reference Jira issues in their subject lines. In addition, my commits follow the guidelines from "[How to write a good git commit message](http://chris.beams.io/posts/git-commit/)":
     1. Subject is separated from body by a blank line
     1. Subject is limited to 50 characters (not including Jira issue reference)
     1. Subject does not end with a period
     1. Subject uses the imperative mood ("add", not "adding")
     1. Body wraps at 72 characters
     1. Body explains "what" and "why", not "how"
   
   ### Documentation
   
   - [x] In case of new functionality, my PR adds documentation that describes how to use it.
     - All the public functions and the classes in the PR contain Javadoc that explain what it does
   
 
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


> Replace the example usage in parquet-cli's help message with an actually existent subcommand
> --------------------------------------------------------------------------------------------
>
>                 Key: PARQUET-1593
>                 URL: https://issues.apache.org/jira/browse/PARQUET-1593
>             Project: Parquet
>          Issue Type: Improvement
>          Components: parquet-cli
>            Reporter: Kengo Seki
>            Priority: Trivial
>              Labels: pull-request-available
>
> The following description feels a bit weird since there's no command called "create" actually.
>     
> {code}
>   Examples:
>     # print information for create
>     parquet help create
> {code}



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)