WedX - журнал о программировании и компьютерных науках

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

Мои doc-тесты в Julia требуют квалификации с именем модуля, несмотря на то, что везде вызывается 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-test в src/my_module.jl на my_module.add(1,2), то он работает нормально.

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

namespaces julia doctest
06.07.2018

Ответы:


1

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

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

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
06.07.2018
  • Это также не удается с > Output Diff: 3ERROR: UndefVarError: add not defined. Я пробовал другие варианты, такие как using my_module и using my_module: add. 11.07.2018

    • 2

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

    export add

    И тогда док-тестирование работает.

    20.07.2018
    Новые материалы
    Объяснение документов 02: BERT
    BERT представил двухступенчатую структуру обучения: предварительное обучение и тонкая настройка. Во время предварительного обучения модель обучается на неразмеченных данных с помощью..
    Как проанализировать работу вашего классификатора?
    Не всегда просто знать, какие показатели использовать С развитием глубокого обучения все больше и больше людей учатся обучать свой первый классификатор. Но как только вы закончите..
    Работа с цепями Маркова, часть 4 (Машинное обучение)
    Нелинейные цепи Маркова с агрегатором и их приложения (arXiv) Автор : Бар Лайт Аннотация: Изучаются свойства подкласса случайных процессов, называемых дискретными нелинейными цепями Маркова..
    Crazy Laravel Livewire упростил мне создание электронной коммерции (панель администратора и API) [Часть 3]
    Как вы сегодня, ребята? В этой части мы создадим CRUD для данных о продукте. Думаю, в этой части я не буду слишком много делиться теорией, но чаще буду делиться своим кодом. Потому что..
    Использование машинного обучения и Python для классификации 1000 сезонов новичков MLB Hitter
    Чему может научиться машина, глядя на сезоны новичков 1000 игроков MLB? Это то, что исследует это приложение. В этом процессе мы будем использовать неконтролируемое обучение, чтобы..
    Учебные заметки: создание моего первого пакета Node.js
    Это мои обучающие заметки, когда я научился создавать свой самый первый пакет Node.js, распространяемый через npm. Оглавление Глоссарий I. Новый пакет 1.1 советы по инициализации..
    Забудьте о Matplotlib: улучшите визуализацию данных с помощью умопомрачительных функций Seaborn!
    Примечание. Эта запись в блоге предполагает базовое знакомство с Python и концепциями анализа данных. Привет, энтузиасты данных! Добро пожаловать в мой блог, где я расскажу о невероятных..
    Для любых предложений по сайту: [email protected]