Add documentation to every function and automatic doc html building (#6)

Reviewed-on: Rubydragon/MetagraphOptimization.jl#6
Co-authored-by: Anton Reinhard <anton.reinhard@proton.me>
Co-committed-by: Anton Reinhard <anton.reinhard@proton.me>
This commit is contained in:
2023-08-29 12:57:46 +02:00
committed by Anton Reinhard
parent 8014bbffcd
commit 065236be22
53 changed files with 1628 additions and 141 deletions

14
src/task/create.jl Normal file
View File

@ -0,0 +1,14 @@
"""
copy(t::AbstractDataTask)
Fallback implementation of the copy of an abstract data task, throwing an error.
"""
copy(t::AbstractDataTask) =
error("Need to implement copying for your data tasks!")
"""
copy(t::AbstractComputeTask)
Return a copy of the given compute task.
"""
copy(t::AbstractComputeTask) = typeof(t)()