Skip to content

Preserve RDoc labeled lists in generated markdown #56

Description

@skatkov

Summary

RDoc labeled lists are currently flattened into plain paragraphs instead of being preserved as labeled/definition lists in generated markdown.

Reference

RDoc Markup reference: https://www.mikeperham.com/wp-content/uploads/2010/12/rdoc.html

Example source

# Label list probe
#
# [cat] small domestic animal
# [dog]
#   loyal friend
#
# alpha:: first item
# beta::
#   second item
class LabelListProbe
  # noop
  def call; end
end

Current markdown output

Label list probe

cat

small domestic animal

dog

loyal friend

alpha

first item

beta

second item

Expected behavior

The generated markdown should preserve the RDoc list structure instead of flattening labels and bodies into separate paragraphs.

For example, output along these lines would be much easier to consume:

cat:
small domestic animal

dog:
loyal friend

alpha:
first item

beta:
second item

or another markdown representation that keeps the label/body relationship intact.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions