yard icon indicating copy to clipboard operation
yard copied to clipboard

Flatened lists on markdown yri

Open 3ynm opened this issue 2 years ago • 2 comments

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:

  • OS: ArchLinux
  • Ruby version (ruby -v): ruby 3.0.0p0 (2020-12-25 revision 95aff21468) [x86_64-linux]
  • YARD version (yard -v): yard 0.9.27

3ynm avatar Jan 12 '22 11:01 3ynm

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.

lsegal avatar Jan 24 '22 20:01 lsegal

I observe the same behavior with RDoc

image

3ynm avatar Sep 30 '22 15:09 3ynm