Revising "docstring" f(::A{T}) where T fails with semi-helpful error message
#735
Comments
mgkurtz
added a commit
to mgkurtz/AbstractAlgebra.jl
that referenced
this issue
Feb 23, 2023
fingolfin
pushed a commit
to Nemocas/AbstractAlgebra.jl
that referenced
this issue
Feb 23, 2023
fredrikekre
added a commit
that referenced
this issue
Nov 9, 2023
This patch adds a (minimal?) targeted hack to workaround an issue where a method signature for documentation fails lowering (#735). Specifically, when revising the following code: ```julia struct Foo{T} end "docs" Foo{T}(::Int) where T ``` lowering errors for the expression `:(Foo{T}(::Int) where T)` with `"invalid :: syntax"`. This patch simply ignores the expression when this situation is detected. Note that, just after, the full expression (docstring + signature) is lowered together succesfully. In particular this means that the docstring will still be updated correctly.
|
Just ran into this, thanks for the workaround. I made a PR to hack around this issue, see #773. |
fredrikekre
added a commit
that referenced
this issue
Nov 9, 2023
Revise extracts the documented expression and puts that before the full
doc expression in the revision queue. E.g. in `"docs" f(x) = x` there
will be a revision of `f(x) = x` followed by a revision of the full
expresion (`"docs" f(x) = x`). However, in many cases a docstring is
only attached to a signature (not a function body/struct definition,
etc.) and in this case the revision of the signature is not needed.
Revise already filters out the base case, `:("docs" f(x))`. This patch
extends this filtering to also apply to `where`-clauses such as e.g.
`"docs" f(x::T) where T <: Integer`.
Concretely, this patch fixes #735, i.e. revising doc expressions where
the signature doesn't lower without the context of the doc macro. As a
bonus, slightly less work has to be done for e.g. `"docs" f(x::T) where
T` since this is also filtered out.
fredrikekre
added a commit
that referenced
this issue
Nov 9, 2023
Revise extracts the documented expression and puts that before the full doc expression in the revision queue. E.g. in `"docs" f(x) = x` there will be a revision of `f(x) = x` followed by a revision of the full expresion (`"docs" f(x) = x`). However, in many cases a docstring is only attached to a signature (not a function body/struct definition, etc.) and in this case the revision of the signature is not needed. Revise already filters out the base case, `"docs" f(x)`. This patch extends this filtering to also apply to `where`-clauses such as e.g. `"docs" f(x::T) where T <: Integer`. Concretely, this patch fixes #735, i.e. revising doc expressions where the signature doesn't lower without the context of the doc macro. As a bonus, slightly less work has to be done for e.g. `"docs" f(x::T) where T` since this is also filtered out.
fredrikekre
added a commit
that referenced
this issue
Nov 9, 2023
Revise extracts the documented expression and puts that before the full doc expression in the revision queue. E.g. in `"docs" f(x) = x` there will be a revision of `f(x) = x` followed by a revision of the full expresion (`"docs" f(x) = x`). However, in many cases a docstring is only attached to a signature (not a function body/struct definition, etc.) and in this case the revision of the signature is not needed. Revise already filters out the base case, `"docs" f(x)`. This patch extends this filtering to also apply to `where`-clauses such as e.g. `"docs" f(x::T) where T <: Integer`. Concretely, this patch fixes #735, i.e. revising doc expressions where the signature doesn't lower without the context of the doc macro. As a bonus, slightly less work has to be done for e.g. `"docs" f(x::T) where T` since this is also filtered out.
KristofferC
pushed a commit
that referenced
this issue
Nov 10, 2023
* Filter out more doc signature expressions Revise extracts the documented expression and puts that before the full doc expression in the revision queue. E.g. in `"docs" f(x) = x` there will be a revision of `f(x) = x` followed by a revision of the full expresion (`"docs" f(x) = x`). However, in many cases a docstring is only attached to a signature (not a function body/struct definition, etc.) and in this case the revision of the signature is not needed. Revise already filters out the base case, `"docs" f(x)`. This patch extends this filtering to also apply to `where`-clauses such as e.g. `"docs" f(x::T) where T <: Integer`. Concretely, this patch fixes #735, i.e. revising doc expressions where the signature doesn't lower without the context of the doc macro. As a bonus, slightly less work has to be done for e.g. `"docs" f(x::T) where T` since this is also filtered out. * Set version to 3.5.8.
|
Nice detective work @mgkurtz and thanks for #774 @fredrikekre! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
I can write code like
This is valid Julia code, but Revise cannot revise it and gives a not-so-helpful error message.
Steps to reproduce: write the above code in
/path/to/file/Foo.jl. Start the Julia REPL and typeThen add a line like
x=42to Foo.jl and try to access it in the REPL. You will getThis is semi-helpfull. Working on a large file written by others, I had some trouble pin-pointing this error. Changing
methods_by_execution!to also print the statement producing the error, I gotNow, we see, the error arises when
methods_by_execution!callsMeta.lower(Foo, :(f(::A{T} where T))). Without contextf(::A{T}) where Tevaluates toerror("invalid \"::\" syntax"). Hence appropriatelyMeta.lowergives$(Expr(:error, "invalid \"::\" syntax")).For some reason, the error occurs, when the argument to
fis parametric but not, when I just documentf(::Int). Althoughf(::Int)evaluates to the same “invalid "::" syntax” error asf(::A{T}) where Tdoes. Curious.Since working around that bug is rather easy (add an
xin front of::A{T}), I would be happy enough, if I we could provide some useful error message.The text was updated successfully, but these errors were encountered: