Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Code in documentation is broken #256

Open
freemin7 opened this issue May 6, 2020 · 1 comment
Open

Code in documentation is broken #256

freemin7 opened this issue May 6, 2020 · 1 comment

Comments

@freemin7
Copy link

freemin7 commented May 6, 2020

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

@ahojukka5
Copy link
Member

ahojukka5 commented May 6, 2020

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants