Markdown.Paragraph might not contain an array

[krrutkow]

In reference to analytech-solutions/CBinding.jl#89

Documenter doesn't accept Markdown.Paragraph(Markdown.Link(...)) even though it renders in the REPL help mode correctly. It seems that the contents of the paragraph are assumed to be an array, but there is no type restriction on the field to enforce that. Indeed, Documenter works when making a change to meet that assumption (Markdown.Paragraph([Markdown.Link(...)]).

[mortenpi]

The Markdown AST generated by CBinding.jl is, by some definition, invalid. I don't think the parser ever generates AST where the children would not be wrapped in a Vector. So ideally I think the generated AST should be fixed.

But you're right in that the Markdown types do not enforce that, and I don't think we should throw an error here, although we could print a warning. The offending method that would need some sort of a fix is here:

Documenter.jl/src/Utilities/Markdown2.jl

Line 227 in bffc866

_convert_block(b::Markdown.Paragraph) = Paragraph(_convert_inline(b.content))

[krrutkow]

I don't think we should throw an error here, although we could print a warning.

Better yet might be to silently "promote" it to a 1-element Vector if it is not already a Vector.

It appears that something similar is already being done in other situations:

Documenter.jl/src/Utilities/Markdown2.jl

Line 265 in bffc866

nodes = isa(text, AbstractVector) ? text : [text]

[fleimgruber]

@mortenpi I tested this again with Documenter v1.1.0, seeing a similar traceback as before, see analytech-solutions/CBinding.jl#89 (comment). I think it is related, but not the same error?