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

Doc fixes #19701

Merged
merged 7 commits into from
Dec 25, 2016
Merged

Doc fixes #19701

merged 7 commits into from
Dec 25, 2016

Conversation

MichaelHatherly
Copy link
Member

  • Signature changes in stdlib/arrays.md for changes to docstring signatures made in Zeros #19635;
  • switch around Pkg.resolve and Pkg.update to hopefully solve an error encountered by @kshyatt;
  • try to always build docs using strict = true to change doc errors/warnings prior to merging PRs.

@MichaelHatherly MichaelHatherly added docs This change adds or pertains to documentation docsystem The documentation building system labels Dec 23, 2016
Copy link
Contributor

@tkelman tkelman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

when we get doctests running regularly we can have those run in permissive mode except for releases, right?

@MichaelHatherly
Copy link
Member Author

when we get doctests running regularly we can have those run in permissive mode except for releases, right?

I'm going to try see if I can get doctests running on each build in this PR. That should stop things like backtrace line numbers becoming stale. There's a 265-related fix in Documenter that I need to tag first though that's blocking running doctest at the moment.

@tkelman
Copy link
Contributor

tkelman commented Dec 24, 2016

I think line numbers will get annoying to keep changing on master, we can ignore those until release branches. Maybe we should take "running doctests on CI" one step at a time to see how it works day to day?

@MichaelHatherly
Copy link
Member Author

Ok, small steps are fine too. I'll just push the doc version bump and a couple of doctest fixes here, but leave turning on doctests for another time.

JuliaLang#19635 merged two docstrings for
each of `zeros` and `ones` in a single docstring each. This changes the
signatures in the stdlib file to reflect that change.
This avoids an error that occurs when documentaion dep versions
have been updated, but `Pkg.update` hasn't been called which results
in `Pkg.resolve` not being able to find suitable package versions.
This should make travis builds on PRs fail when changes are
made that cause `doc/make.jl` to raise warnings that need to be
addressed prior to merging.
Fixes docs builds on 32bit platforms.
@tkelman tkelman merged commit 55b1230 into JuliaLang:master Dec 25, 2016
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 docsystem The documentation building system
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants