Skip to content

Commit

Permalink
Add a link from Base.Docs to section on documentation (JuliaLang#36748)
Browse files Browse the repository at this point in the history
When saying "Please see the manual section on documentation", actually
provide a link.

Also drop a reference to Julia 0.4 (it probably made sense at some point,
but now it just is mildly confusing).
  • Loading branch information
fingolfin authored Jul 23, 2020
1 parent 6209639 commit 78c62b4
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion base/docs/Docs.jl
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
The `Docs` module provides the `@doc` macro which can be used to set and retrieve
documentation metadata for Julia objects.
Please see the manual section on documentation for more
Please see the manual section on [documentation](@ref man-documentation) for more
information.
"""
module Docs
Expand Down
4 changes: 2 additions & 2 deletions doc/src/manual/documentation.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Documentation
# [Documentation](@id man-documentation)

Julia enables package developers and users to document functions, types and other objects easily
via a built-in documentation system since Julia 0.4.
via a built-in documentation system.

The basic syntax is simple: any string appearing at the toplevel right before an object
(function, macro, type or instance) will be interpreted as documenting it (these are called
Expand Down

0 comments on commit 78c62b4

Please sign in to comment.