lsegal / yard

YARD is a Ruby Documentation tool. The Y stands for "Yay!"
http://yardoc.org
MIT License
1.95k stars 398 forks source link

Flatened lists on markdown yri #1423

Closed 3ynm closed 2 months ago

3ynm commented 2 years ago

Steps to reproduce

  1. Create a test.rb file.
# Bla bla.
#
# - a
# - b
# - c
module TestModule; end
  1. Build docs
yard --markup markdown test.rb
  1. Look on yri
    yri TestModule

Actual Output

----------------------------------------------------- Module: TestModule

    Bla bla.

    - a - b - c

------------------------------------------------------------------------

Expected Output

----------------------------------------------------- Module: TestModule

    Bla bla.

    - a
    - b
    - c

------------------------------------------------------------------------

Environment details:

lsegal commented 2 years ago

YARD passes all markup to the markdown (or markup) processing library on your system. This is likely a configuration issue. Note that YARD does not use markdown processing by default in .rb documentation, this must be set with -m markdown.

If this still doesn't work you may want to look at your markdown library.

3ynm commented 2 years ago

I observe the same behavior with RDoc

image

lsegal commented 2 months ago

Marking this as closed since it is a third-party / configuration issue.