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 jldoctest example in mapreduce(...) #29604

Merged
merged 1 commit into from
Oct 19, 2018

Conversation

thchr
Copy link
Contributor

@thchr thchr commented Oct 11, 2018

Previously, the example produced an error, as no such method exists; just a typo I imagine.

Out of curiosity: isn't it the intention of ```jldoctest ...``` that documentation-examples such as this one would be automatically checked and caught by Documenter.jl's doctests?

@KristofferC
Copy link
Member

Yes, they are indeed supposed to be checked and the log suggest they are, e.g. https://travis-ci.org/JuliaLang/julia/jobs/439252959#L3548. If they are actually not running then that is bad and need fixing.

@thchr
Copy link
Contributor Author

thchr commented Oct 11, 2018

I see, thanks.
This particular line is ~8 months old, so unless I'm missing something (I guess CI will show) it ought to have produced an error for a while.

@mortenpi
Copy link
Contributor

I don't think this particular docstring is included in the manual. I can only find https://docs.julialang.org/en/v1.1-dev/base/collections/#Base.mapreduce-Tuple{Any,Any,Any}

If it is not spliced into the manual then it does not get tested (a behaviour which I am planning to change with JuliaDocs/Documenter.jl#774).

@thchr
Copy link
Contributor Author

thchr commented Oct 11, 2018

Thanks, that explains it: indeed, it seems that hardly any of the array functionality from base/reducedim.jl is included in doc/src/base/arrays.md (I assume that is where it would fit?). That is probably not intentional..?

@fredrikekre
Copy link
Member

That is probably not intentional..?

No, do you feel like adding it?

@fredrikekre fredrikekre added docs This change adds or pertains to documentation backport pending 1.0 labels Oct 12, 2018
@thchr
Copy link
Contributor Author

thchr commented Oct 12, 2018

Sure; I can make a PR for that some time next week, probably. (Or add it to this one, but I guess it's more meaningful to separate it out)

@fredrikekre
Copy link
Member

Just add it to this one when you get time.

@KristofferC KristofferC merged commit 3b7be23 into JuliaLang:master Oct 19, 2018
KristofferC pushed a commit that referenced this pull request Oct 29, 2018
KristofferC pushed a commit that referenced this pull request Feb 11, 2019
KristofferC pushed a commit that referenced this pull request Feb 20, 2020
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.

4 participants