search

JuliaFEM / JuliaFEM.jl

The JuliaFEM software library is a framework that allows for the distributed processing of large Finite Element Models across clusters of computers using simple programming models. It is designed to scale up from single servers to thousands of machines, each offering local computation and storage.
http://juliafem.github.io/JuliaFEM.jl/latest/
MIT License
249 stars 66 forks source link

Code in documentation is broken #256

Open freemin7 opened 4 years ago

freemin7 commented 4 years ago

I saw this: http://www.juliafem.org/JuliaFEM.jl/latest/packages/FEMBase/basis/ and thought i let you know.

ahojukka5 commented 4 years ago

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.