Skip to content

Commit 2103b17

Browse files
committed
Fix two small bugs in documentation about docstrings
Missing space broke formatting. The equation wasn't rendered correctly.
1 parent 9d527c5 commit 2103b17

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

doc/manual/documentation.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ with a four-space indent so that it is printed as Julia code.
6262
several related methods of a given function. When a function accepts many keyword
6363
arguments, only include a ``<keyword arguments>`` placeholder in the signature (i.e.
6464
``f(x; <keyword arguments>)``), and give the complete list under an ``# Arguments``
65-
section (see point 4 below).
65+
section (see point 4 below).
6666

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

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

0 commit comments

Comments
 (0)