-
-
Notifications
You must be signed in to change notification settings - Fork 5.4k
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
Doctest ALL the things #20274
Comments
The Linear Algebra section of the manual is already doctested, in #19733 |
#20125 was Multidimensional Arrays |
Note that many of these files could certainly use more doctested examples, even if the conversion of existing ones is complete! |
Yeah that is always the case. This issue is mostly to make sure the current stuff is correct. |
Interfaces: #20287 |
#20288 |
Rip. |
Good thing you only yolo once... Is there an easy way to see what doc tests were affected, or is it just brute force going through them all on the latest master? |
just run the tests and go through them I think |
Okay... Don't know if any of you have started, but I'm working my way though the spaces. |
Is this expected during |
Hmm.. I haven't seen it before. |
We should think about adding a doctest mode to documenter that outputs valid patch files you could just pipe to |
That'd be pretty cool! |
I'll try to
good idea |
Hm, this is the full error Documenter: populating indices.
ERROR: LoadError: `makedocs` encountered an error. Terminating build
Stacktrace:
[1] runner(::Type{Documenter.Builder.RenderDocument}, ::Documenter.Documents.Document) at /home/pkm/julia/julia/doc/deps/v0.6/Documenter/src/Builder.jl:202
[2] dispatch(::Type{Documenter.Builder.DocumentPipeline}, ::Documenter.Documents.Document) at /home/pkm/julia/julia/doc/deps/v0.6/Documenter/src/Selectors.jl:164
[3] cd(::Documenter.##2#3{Documenter.Documents.Document}, ::String) at ./file.jl:69
[4] #makedocs#1(::Bool, ::Array{Any,1}, ::Function) at /home/pkm/julia/julia/doc/deps/v0.6/Documenter/src/Documenter.jl:159
[5] (::Documenter.#kw##makedocs)(::Array{Any,1}, ::Documenter.#makedocs) at ./<missing>:0
[6] include_from_node1(::String) at ./loading.jl:539
[7] include(::String) at ./sysimg.jl:14
[8] process_options(::Base.JLOptions) at ./client.jl:304
[9] _start() at ./client.jl:370
while loading /home/pkm/julia/julia/doc/make.jl, in expression starting on line 115
Makefile:54: recipe for target 'doctest' failed
make: *** [doctest] Error 1
make: Leaving directory '/home/pkm/julia/julia/doc' is this simply because there were doctest errors? |
Wouldn't it be easier to just run all the doctests through julia and replace the output in the docs? Then doing |
That would remove the error checking part from the doctests I guess but perhaps it's fine to say that tests should just be in CI |
I wouldn't want running the doctests to write changes to base sources by default, what if you build from a release tarball and do that. |
Obviously not, but it could be a different make target. |
@pkofod yes, if you run in strict mode then that will happen if there are any errors in the build |
I am on it, I've just been AFK for a while. I'll make a PR when they're adjusted. (edit is fixed in #20417 by vtjnash) |
I just want to say thank you all so much for doing this, it's fantastic! 💯 |
Nice job broses and sises. |
Actually, #20297 is still open. Oh well. I close this anyway :P |
This is a list of all files that need doctests in the manual. If you have a PR in progress to doctest a file please claim it here. This is in order for people not to do double work. If there is a file that you know of that is fully doctests, please mention it as well.
cc @fredrikekre.
The text was updated successfully, but these errors were encountered: