Filter out more doc signature expressions #774
Merged
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
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
force-pushed
the
fe/nohack
branch
from
fb259da
to
64ff658
Compare
|
CI failures are unrelated -- looks like tests need a bit of work to pass on nightly (probably the result of stdlib excision). |
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.
Revise extracts the documented expression and puts that before the full
doc expression in the revision queue. E.g. in
"docs" f(x) = xtherewill be a revision of
f(x) = xfollowed by a revision of the fullexpresion (
"docs" f(x) = x). However, in many cases a docstring isonly 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 patchextends 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 Tsince this is also filtered out.