Почему Julia Documenter требует квалификационных функций в doc-тестах?

Question

Мои doc-тесты в Юлии требуют уточнения с именем модуля, несмотря на то, что везде using my_module. Если я не квалифицирую функции, я получаю

ERROR: UndefVarError: add not defined

Вот настройка, которая выдает эту ошибку. Структура каталогов с tree:

.
|____docs
| |____make.jl
| |____src
| | |____index.md
|____src
| |____my_module.jl

Файл docs/make.jl:

using Documenter, my_module

makedocs(
    modules = [my_module],
    format = :html,
    sitename = "my_module.jl",
    doctest = true
)

Файл docs/src/index.md:

# Documentation

```@meta
CurrentModule = my_module
DocTestSetup = quote
    using my_module
end
```

```@autodocs
Modules = [my_module]
```

Файл src/my_module.jl:

module my_module

"""
    add(x, y)

Dummy function

# Examples
```jldoctest
julia> add(1, 2)
3
```
"""
function add(x::Number, y::Number)
    return x + y
end

end

Если я квалифицирую doc-тест в src/my_module.jl с my_module.add(1,2), то он работает нормально.

Как можно избежать уточнения имен функций в doc-тестах?

Answer 1

После комментариев в этой теме проблема в том, что функция add не экспортируется, поэтому она не переносится в область действия using. Вы можете добавить эту строку в верхней части src/my_module.jl после объявления модуля:

export add

А потом работает doc-тестирование.

Answer 2

Использовать блок имени установки

Это не проверено, но что-то вроде этого должно работать:

module my_module

"""
    add(x, y)

Dummy function

# Examples
```@setup abc
import my_module: add
```

```jldoctest abc
julia> add(1, 2)
3
```
"""
function add(x::Number, y::Number)
    return x + y
end

end