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 doctests in docstrings #19562

Merged
merged 2 commits into from
Dec 12, 2016

Conversation

MichaelHatherly
Copy link
Member

Notable changes:

  • sparse matrix printing indent changed to match that of sparse vectors, namely two space indent not single tab;
  • removal of ... after many backtraces which weren't needed;
  • removal of <BLANKLINE> since we just use a blankline instead;
  • fix bad indentation of some doctests, which were causing them not to be run;
  • update line numbers in some backtraces;
  • use named doctests for splice! to share state between two tests.

This only fixes doctests in base, not in doc/src. I'll put the changes to doc/src in another PR once this one is done.

Uses two space indent rather than a tab to match the indent used
by sparse vector printing.
Notable changes:

  * sparse matrix printing indent changed to match that
    of sparse vectors, namely two space indent not single tab;
  * removal of `...` after many backtraces which weren't needed;
  * removal of `<BLANKLINE>` since we just use a blankline instead;
  * fix bad indentation of some doctests, which were causing them
    not to be run;
  * update line numbers in some backtraces;
  * use named doctests for `splice!` to share state between two tests.

This only fixes doctests in `base`, not in `doc/src`.
@kshyatt kshyatt added the docsystem The documentation building system label Dec 12, 2016
@StefanKarpinski
Copy link
Member

Tests passed; @tkelman approved; it doesn't get better than that. Merge?

@MichaelHatherly MichaelHatherly merged commit 7f5ae13 into JuliaLang:master Dec 12, 2016
@MichaelHatherly MichaelHatherly deleted the mh/fix-doctests branch December 12, 2016 23:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docsystem The documentation building system
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants