Fix documenting baremodules #13067
Merged
Fix documenting baremodules #13067
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Prior to this fix attempting to document baremodules results in an infinite
error message plus segfault when trying to escape:
julia> "..." baremodule M end
This fix imports `call` and `@doc` into the module automatically.
Also makes documenting empty baremodules an error since that was also
causing segfaults. That limitation won't impact any real-world code though.
Tests and documentation updates as well.
jakebolewski
added a commit
that referenced
this pull request
Sep 11, 2015
Fix documenting baremodules
|
I think if pure julia can segfault there is still a bug to fix somewhere ? Or did I misunderstood ? |
|
He catches that case and throws an error. Was going to open another issue for the bare mode segfault. |
tkelman
pushed a commit
that referenced
this pull request
Sep 11, 2015
Prior to this fix attempting to document baremodules results in an infinite
error message plus segfault when trying to escape:
julia> "..." baremodule M end
This fix imports `call` and `@doc` into the module automatically.
Also makes documenting empty baremodules an error since that was also
causing segfaults. That limitation won't impact any real-world code though.
Tests and documentation updates as well.
(cherry picked from commit 8edd917)
ref #13067
|
@carnaval, pushing the diff --git a/base/docs/Docs.jl b/base/docs/Docs.jl
index 6e6a4db..915bc92 100644
--- a/base/docs/Docs.jl
+++ b/base/docs/Docs.jl
@@ -471,8 +471,7 @@ function moddoc(meta, def, name)
def = unblock(def)
block = def.args[3].args
if !def.args[1]
- isempty(block) && error("empty baremodules are not documentable.")
- insert!(block, 2, :(import Base: call, @doc))
+ unshift!(block, :(import Base: call, @doc))
end
push!(block, docex)
esc(Expr(:toplevel, def))and then doing gives the following error. I'm having trouble reducing it much more than that though. |
|
backported in #13072 |
|
@MichaelHatherly @carnaval the error comes from the fact that the global |
|
I actually just get an BoundsError on |
|
You have to apply the patch to reproduce the bug. As the array is zero length, it is expected you will get a bounds error with |
|
Ahh.. I somehow missed the second line of the patch... |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Prior to this fix attempting to document baremodules results in an infinite error message plus segfault when trying to escape:
This fix imports
calland@docinto the module automatically.Also makes documenting empty baremodules an error since that was also causing segfaults. That limitation won't impact any real-world code though.
Tests and documentation updates as well.