Skip to content

Add notes that doc lookup requires REPL #52065

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 20, 2025
Merged

Add notes that doc lookup requires REPL #52065

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions base/docs/Docs.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,10 @@ You can retrieve docs for functions, macros and other objects as follows:
@doc @time
@doc md""

!!! compat "Julia 1.11"
In Julia 1.11 and newer, retrieving documentation with the `@doc` macro requires that
the `REPL` stdlib is loaded.

## Functions & Methods
Placing documentation before a method definition (e.g. `function foo() ...` or `foo() = ...`)
will cause that specific method to be documented, as opposed to the whole function. Method
Expand Down Expand Up @@ -787,6 +791,9 @@ When `pattern` is a string, case is ignored. Results are printed to `io`.
```
help?> "pattern"
```

!!! compat "Julia 1.11"
In Julia 1.11 and newer, `apropos` requires that the `REPL` stdlib is loaded.
"""
function apropos end

Expand All @@ -797,6 +804,9 @@ Return all documentation that matches both `binding` and `sig`.

If `getdoc` returns a non-`nothing` result on the value of the binding, then a
dynamic docstring is returned instead of one based on the binding itself.

!!! compat "Julia 1.11"
In Julia 1.11 and newer, `Docs.doc` requires that the `REPL` stdlib is loaded.
"""
function doc end

Expand Down
4 changes: 4 additions & 0 deletions doc/src/manual/documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -331,6 +331,10 @@ documentation between different versions of a function:
@doc (@doc foo!) foo
```

!!! compat "Julia 1.11"
In Julia 1.11 and newer, retrieving documentation with the `@doc` macro requires that
the `REPL` stdlib is loaded.

Or for use with Julia's metaprogramming functionality:

```julia
Expand Down