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
567 stars 74 forks source link

ParenthesizedSentence incorrectly described in Japanese documentation #729

Open edwardwoodward opened 8 years ago

edwardwoodward commented 8 years ago

The Japanese documentation states that max_length checks the number of words (単語数) in parentheses. It doesn't - it checks the number of characters. Also, the default value of max_length is 4, which is too few if it is counting characters, I think.

takahi-i commented 8 years ago

Hi @edwardwoodward. Thank you very much for telling us a mistake in RedPen document. The RedPen document is also hosted in GitHub. The following is the URL.

https://github.com/redpen-cc/redpen-doc

The document is written in a simple right weight markup language, AsciiDoc, And therefore I thinks you can make the fix for the problem.

That would be appreciate it if you give us the pull request for us.

edwardwoodward commented 8 years ago

I don't mind doing this, but I need some sort of explanation of the procedure, preferably in plain English. Alternatively, you just give me the file you want me to edit and I'll edit it and return it.