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

Fix failing doctests #22115

Merged
merged 1 commit into from
May 30, 2017
Merged

Fix failing doctests #22115

merged 1 commit into from
May 30, 2017

Conversation

xorJane
Copy link
Contributor

@xorJane xorJane commented May 29, 2017

I made minor changes to expected outputs for doctests, like updating line numbers. Now all doctests pass. Thank you!

@kshyatt kshyatt added the docs This change adds or pertains to documentation label May 30, 2017
@kshyatt kshyatt merged commit fc6cf1a into JuliaLang:master May 30, 2017
@tkelman
Copy link
Contributor

tkelman commented May 30, 2017

For future reference, there's a bit of a shortcut for fixing these. Do

make docs # be sure your julia build is up-to-date
cd doc/deps/v0.7/Documenter
git show origin/fix-doctests | git apply
cd ../../..
make doctest # this will auto-update the expected output to match the actual
make clean # get rid of modifications to documenter
make -C .. # rebuild julia to update compiled docstring info
make doctest # should hopefully pass

and check that the resulting git diff looks sane (this procedure would have done something slightly insane on metaprogramming.md here, probably because the previous output was empty). x-ref JuliaDocs/Documenter.jl#448, hopefully this can be made a proper feature in Documenter that we could add a makefile target for so it would just be make -C doc fix-doctests or something like that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants