Skip to content

Commit

Permalink
update the syntax in the docstring for @doc to align with current u…
Browse files Browse the repository at this point in the history 
…ses (#54184)

Also, take the opportunity to "soften" the language a bit.
  • Loading branch information
@KristofferC
KristofferC authored Apr 23, 2024
1 parent 2ca9e00 commit 715c476
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions base/docs/Docs.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,9 @@ module Docs
Functions, methods and types can be documented by placing a string before the definition:
\"\"\"
# The Foo Function
`foo(x)`: Foo the living hell out of `x`.
foo(x)
Return a fooified version of `x`.
\"\"\"
foo(x) = ...
Expand Down

2 comments on commit 715c476

@nanosoldier
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Executing the daily package evaluation, I will reply here when finished:

@nanosoldier runtests(isdaily = true)

@nanosoldier
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The package evaluation job you requested has completed - possible new issues were detected.
The full report is available.

Please sign in to comment.