Crystal: Markdown is displayed differently in docs

[cheeze2000]

I commented a method like such.

# - cat
# - dog
def animal
end

Using crystal docs, the docs generated shows that the markdown is displayed differently. This is how it looks like in the "Instance Method Summary".

However, it looks like this in the "Instance Method Detail".

$ crystal -v
Crystal 0.29.0 (2019-06-06)

LLVM: 6.0.1
Default target: x86_64-pc-linux-gnu

OS: Manjaro Linux x86_64
Kernel: 4.19.56-1-MANJARO

[girng]

so the issue is basically markdown lists are not supported in instance method summary section?

is this a bug or intended?

[Blacksmoke16]

@cheeze2000 The summary only show the first line/sentence. If anything I'd say this is an issue with the logic that does that. However I don't think it should show the list, as the summary is only a single line.

If anything (and arguably better) can do something like

# Returns the animal associated with `self`.
#
# - cat
# - dog
def animal

[cheeze2000]

You're right. There is a reason why it is called the summary. Thank you for the help.