Code in documentation is broken
freemin7 opened this issue · 1 comments
freemin7 commented
I saw this: http://www.juliafem.org/JuliaFEM.jl/latest/packages/FEMBase/basis/ and thought i let you know.
ahojukka5 commented
Yes, it has been more or less broken all the time. I'm working with the idea of using Literate.jl to generate documentation from unit tests hoping it would be easier to maintain. Because now the situation is that if something in documentation is outdated or broken, we cannot catch that in CI.
https://github.com/JuliaFEM/FEMBase.jl/blob/master/test/test_fields.jl
After Literate.jl:
http://www.juliafem.org/FEMBase.jl/latest/fields/
It's going to be something like this. Of course, this needs big modifications to test files but it's mostly copy-paste from the existing documentation.