Skip to content

Commit 715c476

Browse files
authored
update the syntax in the docstring for @doc to align with current uses (#54184)
Also, take the opportunity to "soften" the language a bit.
1 parent 2ca9e00 commit 715c476

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

base/docs/Docs.jl

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,9 @@ module Docs
1919
Functions, methods and types can be documented by placing a string before the definition:
2020
2121
\"\"\"
22-
# The Foo Function
23-
`foo(x)`: Foo the living hell out of `x`.
22+
foo(x)
23+
24+
Return a fooified version of `x`.
2425
\"\"\"
2526
foo(x) = ...
2627

0 commit comments

Comments
 (0)