Wrong list layout when only one argument is used

[mdosch]

Thanks for ronn-ng, as writing manpages in markdown is very comfortable.

System

Debian Bullseye (testing)

ronn/testing,testing,unstable,unstable,now 0.9.1-1 all  [installiert]
  tool to build manuals from Markdown

ruby-ronn/testing,testing,unstable,unstable,now 0.9.1-1 all  [Installiert,automatisch]
  library to build manuals from Markdown

Issue

When I have only one argument in a list the list is not rendered as I expect it.

## COMMANDS    
    
* `-d`, `--debug`:    
Show debug information.    
    
* `-d`:    
Show debug information.  

I would expect both to render the same but they are rendered differently:

It looks a bit weird if there is no linebreak before some descriptions.

[apjanke]

Thanks for ronn-ng, as writing manpages in markdown is very comfortable.

You're welcome!

When I have only one argument in a list the list is not rendered as I expect it.

Hmm. I'm unable to reproduce this using Ronn-NG 0.9.1 on macOS 10.14. Both forms have a newline for me.

[ronn-list-layout] $ cat foo.ronn
## COMMANDS

* `-d`, `--debug`:
Show debug information.

* `-d`:
Show debug information.

[ronn-list-layout] $ ronn foo.ronn
     roff: ./foo
     html: ./foo.html                                            +man
[ronn-list-layout] $ cat foo
.\" generated with Ronn-NG/v0.9.1
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
.TH "FOO" "" "December 2020" ""
.SH "NAME"
\fBfoo\fR
.SH "COMMANDS"
.IP "\[ci]" 4
\fB\-d\fR, \fB\-\-debug\fR:
.br
Show debug information\.
.IP "\[ci]" 4
\fB\-d\fR:
.br
Show debug information\.
.IP "" 0

[ronn-list-layout] $ man ./foo | cat
FOO()                                                                    FOO()



NAME
       foo

COMMANDS
       O   -d, --debug:
           Show debug information.

       O   -d:
           Show debug information.






                                 December 2020                           FOO()
[ronn-list-layout] $

Maybe there's a difference in our man or roff tools here, that's causing a difference in rendering downstream from ronn?

What do you get for cat foo if you do this same test?

[mdosch]

Oh, looks like you are right: ``` cat test .\" generated with Ronn-NG/v0.9.1 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1 .TH "TEST" "" "December 2020" "" .SH "NAME" \fBtest\fR .SH "COMMANDS" .TP \fB\-d\fR, \fB\-\-debug\fR Show debug information\. .TP \fB\-d\fR Show debug information\. ``` So it seems the man viewer is doing something there. Sorry for the noise then. :)

…

On 04.12.2020 14:23, Andrew Janke wrote: > Thanks for ronn-ng, as writing manpages in markdown is very comfortable. You're welcome! > When I have only one argument in a list the list is not rendered as I expect it. Hmm. I'm unable to reproduce this using Ronn-NG 0.9.1 on macOS 10.14. Both forms have a newline for me. ``` [ronn-list-layout] $ cat foo.ronn ## COMMANDS * `-d`, `--debug`: Show debug information. * `-d`: Show debug information. [ronn-list-layout] $ ronn foo.ronn roff: ./foo html: ./foo.html +man [ronn-list-layout] $ cat foo .\" generated with Ronn-NG/v0.9.1 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1 .TH "FOO" "" "December 2020" "" .SH "NAME" \fBfoo\fR .SH "COMMANDS" .IP "\[ci]" 4 \fB\-d\fR, \fB\-\-debug\fR: .br Show debug information\. .IP "\[ci]" 4 \fB\-d\fR: .br Show debug information\. .IP "" 0 [ronn-list-layout] $ man ./foo | cat FOO() FOO() NAME foo COMMANDS O -d, --debug: Show debug information. O -d: Show debug information. December 2020 FOO() [ronn-list-layout] $ ``` Maybe there's a difference in our `man` or `roff` tools here, that's causing a difference in rendering downstream from `ronn`? What do you get for `cat foo` if you do this same test? -- You are receiving this because you authored the thread. Reply to this email directly or view it on GitHub: #64 (comment)

[apjanke]

Hmmm. Actually, that output you posted doesn't look quite right to me; there should be some .brs in there. Keeping this open for further review.