Skip to content

Commit d825de8

Browse files
authored
Give example docstring one-line summary (#36158)
Point 2 of conventions immediately below this example calls for one line summary. Closes #36147
1 parent 1ef13ac commit d825de8

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

doc/src/manual/documentation.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,9 @@ Here is a more complex example, still using Markdown:
2929
"""
3030
bar(x[, y])
3131
32-
Compute the Bar index between `x` and `y`. If `y` is missing, compute
33-
the Bar index between all pairs of columns of `x`.
32+
Compute the Bar index between `x` and `y`.
33+
34+
If `y` is unspecified, compute the Bar index between all pairs of columns of `x`.
3435
3536
# Examples
3637
```julia-repl

0 commit comments

Comments
 (0)