Skip to content

Commit

Permalink
Fix two small bugs in documentation about docstrings
Browse files Browse the repository at this point in the history
Missing space broke formatting. The equation wasn't rendered
correctly.
  • Loading branch information
nalimilan committed Mar 28, 2016
1 parent 9d527c5 commit 2103b17
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions doc/manual/documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ with a four-space indent so that it is printed as Julia code.
several related methods of a given function. When a function accepts many keyword
arguments, only include a ``<keyword arguments>`` placeholder in the signature (i.e.
``f(x; <keyword arguments>)``), and give the complete list under an ``# Arguments``
section (see point 4 below).
section (see point 4 below).

2. Include a single one-line sentence describing what the function does or what the
object represents after the simplified signature block. If needed, provide more details
Expand Down Expand Up @@ -113,7 +113,7 @@ standard text.
Julia identifiers and code excerpts should always appear between backticks `````
to enable highlighting. Equations in the LaTeX syntax can be inserted between
double backticks ``````. Use Unicode characters rather than their LaTeX escape sequence,
i.e. ````α = 1```` rather than ````\\alpha = 1````.
i.e. ````α = 1```` rather than :samp:`\`\`\\\\alpha = 1\`\``.

7. Place the starting and ending ``"""`` characters on lines by themselves.

Expand Down

0 comments on commit 2103b17

Please sign in to comment.