[jira] [Commented] (PARQUET-2329) Fix wrong help messages of parquet-cli subcommands

["ASF GitHub Bot (Jira)" <ji...@apache.org>]

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

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

sekikn opened a new pull request, #1126:
URL: https://github.com/apache/parquet-mr/pull/1126

   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-2329
     - 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:
   
   No additional test, since it's just a fix for the help messages. Instead, I manually ensured that parquet-cli was successfully built and it printed out the help messages expected with this PR.
   
   ### 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
   




> Fix wrong help messages of parquet-cli subcommands
> --------------------------------------------------
>
>                 Key: PARQUET-2329
>                 URL: https://issues.apache.org/jira/browse/PARQUET-2329
>             Project: Parquet
>          Issue Type: Bug
>          Components: parquet-cli
>            Reporter: Kengo Seki
>            Assignee: Kengo Seki
>            Priority: Trivial
>
> There are some minor mistakes in the help messages of parquet-cli, as follows:
> {code}
> $ java -cp 'target/parquet-cli-1.14.0-SNAPSHOT.jar:target/dependency/*' org.apache.parquet.cli.Main help rewrite
> ...
>     --prune-columns
> 	<columns to be replaced with masked value>
> {code}
> It is the description about the {{\-\-mask-columns}} option, not for {{\-\-prune-columns}}.
> {code}
> $ java -cp 'target/parquet-cli-1.14.0-SNAPSHOT.jar:target/dependency/*' org.apache.parquet.cli.Main help convert-csv
> ...
>   Examples:
>     # Create a Parquet file from a CSV file
>     parquet convert-csv sample.csv sample.parquet --schema schema.avsc
>     # Create a Parquet file in HDFS from local CSV
>     parquet convert-csv path/to/sample.csv hdfs:/user/me/sample.parquet --schema schema.avsc
>     # Create an Avro file from CSV data in S3
>     parquet convert-csv s3:/data/path/sample.csv sample.avro --format avro --schema s3:/schemas/schema.avsc
> {code}
> Output paths in these examples should be specified using the {{-o}}/{{\-\-output}} option. In addition, that subcommand doesn't have the {{\-\-format}} option.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)