Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

@doc (MD object) doesn't print with horizontal bars between methods, which can mislead the reader. #54486

Open
NHDaly opened this issue May 15, 2024 · 0 comments
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

Comments

@NHDaly
Copy link
Member

NHDaly commented May 15, 2024

Consider this docstring:
Screenshot 2024-05-15 at 5 06 11 PM

This very much appears to be one docstring for rem(x, ::Type), which has two consecutive Examples 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 (?):
Screenshot 2024-05-10 at 9 29 47 AM

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.

@NHDaly NHDaly added domain:docs This change adds or pertains to documentation status:help wanted Indicates that a maintainer wants help on an issue or pull request docsystem The documentation building system domain:display and printing Aesthetics and correctness of printed representations of objects. labels May 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
None yet
Development

No branches or pull requests

1 participant