-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
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
I love # Example #22522
I love # Example #22522
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Just a thought: I wonder if we should use "##" instead, since "Example" is a subheading to the function signature (which seems to render like "#")? Take a look at e.g. https://docs.julialang.org/en/latest/stdlib/linalg/#Base.LinAlg.dot |
The function signature have a bit of backdrop though. The whole block is also surrounded with the square. In my opinion it looks ok but I don't know how the |
There is also the rendering in the REPL to consider. Here is my REPLsince there are many like itbut this one is mine and rendered documentation with 1-4 #'s (turns out my suggestion wont matter for the rendered docs anyway, sorry for getting off topic from the PR): Personally, I think that in the REPL the function signature (which essentially is the header of the docstring) is way too anonymous compared to the "Example" header. |
We should standardize on whether or not there's a blank line before the |
No description provided.