Convert some docs with **Example** to Markdown
#13102
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
||
| **Example**: | ||
| ``` |
There was a problem hiding this comment.
shouldn't you need to put the language here? ```julia
There was a problem hiding this comment.
Oh, good point, thanks.
There was a problem hiding this comment.
No, actually, I don't -- the output in the ReST already magically says code-julia.. code-block:: julia.
jakebolewski
added a commit
that referenced
this pull request
Sep 13, 2015
Convert some docs with `**Example**` to Markdown
tkelman
added
docs
13 tasks
|
backported in #13107 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This converts a few docstrings to Markdown
These particular ones seem not to have been converted automatically due to
**Example**s,but otherwise do not have any of the other issues documented in #13047
In general, I feel that it would be very useful to add more examples to the documentation when appropriate; the one for
linregis particularly instructive and to the point.