argh icon indicating copy to clipboard operation
argh copied to clipboard

Support multiline docs

Open Timmmm opened this issue 2 years ago • 2 comments

Adds basic support for multiline docstrings. The rule is basically if a line starts with an alphabetic character then it is joined to the previous line.

Fixes #121 Fixes #128

Timmmm avatar Jul 15 '22 20:07 Timmmm

This could land if rebased and reformatted.

sadmac7000 avatar Oct 19 '23 23:10 sadmac7000

I have rebased, formatted and squashed it. Unfortunately there are two issues I found:

  1. The escaped_doc_comment_description test fails due to an extra newline.
  2. You can't start a description with a capital letter which seems overly restrictive and weird for a multi-line paragraph.

I have stopped using argh and switch to Clap, so I'll leave you to decide how to deal with this (fix those issues or just close this).

Timmmm avatar Nov 16 '23 12:11 Timmmm