Cannot document @everywhere function

[matthiasbe]

It seems I can not document and put the @Everywhere annotation at the same time.

The following code

"""
Prints something
"""
@everywhere function my_func()
  println("hello")
end

throws the error

ERROR: LoadError: cannot document the following expression:

#= /path/test.jl:4 =# @everywhere function my_func()
        #= /path/test.jl:4 =#
        #= /path/test.jl:5 =#
        println("hello")
    end

'@everywhere' not documentable. See 'Base.@__doc__' docs for details.

Stacktrace:
 [1] error(::String, ::String) at ./error.jl:42
 [2] top-level scope at /path/test.jl:1
 [3] include(::String) at ./client.jl:457
 [4] top-level scope at REPL[8]:1
in expression starting at /path/test.jl:1

Original discourse post

And my version

julia> versioninfo()
Julia Version 1.5.2
Commit 539f3ce943 (2020-09-23 23:17 UTC)
Platform Info:
  OS: Linux (x86_64-pc-linux-gnu)
  CPU: Intel(R) Core(TM) i7-9850H CPU @ 2.60GHz
  WORD_SIZE: 64
  LIBM: libopenlibm
  LLVM: libLLVM-9.0.1 (ORCJIT, skylake)

[sostock]

Note that the following works:

@everywhere begin
    """
    Prints something
    """
    function my_func()
        println("hello")
    end
end

However, this adds the docstring on every process. Since the docstring is outside of the @everywhere macro call in your example, it should probably only document the function on the calling process.