Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Wrong list layout when only one argument is used #64

Open
mdosch opened this issue Dec 4, 2020 · 3 comments
Open

Wrong list layout when only one argument is used #64

mdosch opened this issue Dec 4, 2020 · 3 comments
Assignees
Labels
bug Something isn't working

Comments

@mdosch
Copy link

mdosch commented Dec 4, 2020

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:

2020-12-04-154056_scrot

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

@apjanke
Copy link
Owner

apjanke commented Dec 4, 2020

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?

@apjanke apjanke self-assigned this Dec 4, 2020
@apjanke apjanke added the bug Something isn't working label Dec 4, 2020
@mdosch
Copy link
Author

mdosch commented Dec 5, 2020 via email

@apjanke
Copy link
Owner

apjanke commented Dec 22, 2020

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.

@apjanke apjanke added this to ronn-ng Jan 4, 2024
@apjanke apjanke moved this to Low priority in ronn-ng Jan 4, 2024
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
bug Something isn't working
Projects
Status: Low priority
Development

No branches or pull requests

2 participants