yard
yard copied to clipboard
Flatened lists on markdown yri
Steps to reproduce
- Create a
test.rb
file.
# Bla bla.
#
# - a
# - b
# - c
module TestModule; end
- Build docs
yard --markup markdown test.rb
- 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
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.
I observe the same behavior with RDoc