@doc
(MD
object) doesn't print with horizontal bars between methods, which can mislead the reader.
#54486
Labels
docsystem
The documentation building system
domain:display and printing
Aesthetics and correctness of printed representations of objects.
domain:docs
This change adds or pertains to documentation
status:help wanted
Indicates that a maintainer wants help on an issue or pull request
Consider this docstring:
This very much appears to be one docstring for
rem(x, ::Type)
, which has two consecutiveExamples
sections, and some text in between.However, what's actually happening is that the end of the first docstring is a codeblock, and the start of the second method's docstring is also a codeblock, so these appear to run together. This is a common occurrence in docstrings, so I imagine this has confused others as well.
Compare that to how the docstring is printed via help (
?
):Now, you can see that this is actually 3 separate methods.
I believe that the
show(::IO, ::MIME"text/plain", ::MD)
function simply needs to be updated to introduce the same------
s that we have in?
help.The text was updated successfully, but these errors were encountered: