Skip to content

Commit

Permalink
Update documentation.md (#41401)
Browse files Browse the repository at this point in the history
In my first reading of the original documentation, I interpreted "right" as the opposite of "left". Also, it was wordy.

Co-authored-by: Fredrik Ekre <[email protected]>
  • Loading branch information
oviedorodolfo and fredrikekre committed Jun 29, 2021
1 parent af4bbfd commit 33810de
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion doc/src/manual/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Julia enables package developers and users to document functions, types and other objects easily
via a built-in documentation system.

The basic syntax is simple: any string appearing at the toplevel right before an object
The basic syntax is simple: any string appearing just before an object
(function, macro, type or instance) will be interpreted as documenting it (these are called
*docstrings*). Note that no blank lines or comments may intervene between a docstring and
the documented object. Here is a basic example:
Expand Down

0 comments on commit 33810de

Please sign in to comment.