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

I love # Example #22522

Merged
merged 1 commit into from
Jun 25, 2017
Merged

I love # Example #22522

merged 1 commit into from
Jun 25, 2017

Conversation

kshyatt
Copy link
Contributor

@kshyatt kshyatt commented Jun 25, 2017

No description provided.

@kshyatt kshyatt added the docs This change adds or pertains to documentation label Jun 25, 2017
Copy link
Member

@KristofferC KristofferC left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@fredrikekre
Copy link
Member

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

@KristofferC
Copy link
Member

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 ## alternative would look.

@fredrikekre
Copy link
Member

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):
screen shot 2017-06-25 at 05 08 04
screen shot 2017-06-25 at 05 13 21

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.

@tkelman
Copy link
Contributor

tkelman commented Jun 25, 2017

We should standardize on whether or not there's a blank line before the ``` (I'd prefer not), and write these conventions down in the docs and contributing guidelines

@kshyatt kshyatt merged commit f030049 into master Jun 25, 2017
@kshyatt kshyatt deleted the ksh/example branch June 25, 2017 17:06
ararslan pushed a commit that referenced this pull request Sep 11, 2017
I love # Example

Ref #22522
(cherry picked from commit f030049)
ararslan pushed a commit that referenced this pull request Sep 13, 2017
Ref #22522
(cherry picked from commit 9c6466a)
vtjnash pushed a commit that referenced this pull request Sep 14, 2017
Ref #22522
(cherry picked from commit 9c6466a)
ararslan pushed a commit that referenced this pull request Sep 15, 2017
Ref #22522
(cherry picked from commit 9c6466a)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants