search

redpen-cc / redpen

RedPen is an open source proofreading tool to check if your technical documents meet the writing standard. RedPen supports various markup text formats (Markdown, Textile, AsciiDoc, Re:VIEW, reStructuredText and LaTeX).
https://redpen.cc
Apache License 2.0
570 stars 74 forks source link

Enrich help message #824

Closed takahi-i closed 6 years ago

takahi-i commented 6 years ago

The following is the updated help message.

usage: redpen-cli [Options] [<INPUT FILE>]

Validate input documents with specified configuration settings.

Options:
 -c,--conf <CONF FILE>                Configuration file (REQUIRED)
 -f,--format <FORMAT>                 Input file format
                                      (markdown,plain,wiki,asciidoc,latex,rest)
 -h,--help                            Displays this help information and exits
 -l,--limit <LIMIT NUMBER>            Error limit number
 -L,--lang <LANGUAGE>                 Language of error messages
 -r,--result-format <RESULT FORMAT>   Output result format
                                      (json,json2,plain,plain2,xml)
 -s,--sentence <INPUT SENTENCES>      Input sentences
 -t,--threshold <THRESHOLD>           Threshold of error level (info, warn,
                                      error)
 -v,--version                         Displays version information and exits

Example:

$redpen -c redpen-config.xml input.md

Note:
Setting files can be generated in http://redpen.herokuapp.com/
coveralls commented 6 years ago

Coverage Status

Coverage remained the same at 91.346% when pulling 7a5654489359fa3bedfd300dd478af13c421e1a4 on takahi-i:enhance-help into 60e4af326b1bfacc6d7acf464dbf3bee6aff2634 on redpen-cc:master.