remove duplicate LinearIndices docs #27037
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
|
Hmm, seems like this was not the full solution, let me investigate. |
mbauman
approved these changes
May 9, 2018
fredrikekre
commented
May 9, 2018
| @@ -377,7 +377,7 @@ module IteratorsMD | |||
| next(iter::Reverse{<:CartesianIndices{0}}, state) = CartesianIndex(), true | |||
| done(iter::Reverse{<:CartesianIndices{0}}, state) = state | |||
|
|
|||
| LinearIndices(inds::CartesianIndices{N,R}) where {N,R} = LinearIndices{N,R}(inds.indices) | |||
| Base.LinearIndices(inds::CartesianIndices{N,R}) where {N,R} = LinearIndices{N,R}(inds.indices) | |||
There was a problem hiding this comment.
This was a module local function, which was undocumented. Documenter then complained that there were no docs, since we reference this function in the same module (L214).
…(::UnitRange{<:Integer})
fredrikekre
commented
May 9, 2018
| @deprecate CartesianIndices(inds::Vararg{AbstractUnitRange{Int},N}) where {N} CartesianIndices(inds) | ||
| @deprecate CartesianIndices(inds::Vararg{AbstractUnitRange{<:Integer},N}) where {N} CartesianIndices(inds) | ||
| @deprecate LinearIndices(inds::Vararg{AbstractUnitRange{Int},N}) where {N} LinearIndices(inds) | ||
| @deprecate LinearIndices(inds::Vararg{AbstractUnitRange{<:Integer},N}) where {N} LinearIndices(inds) |
There was a problem hiding this comment.
These two LinearIndices definitions ended up beeing module local without the import.
fredrikekre
commented
May 9, 2018
| CartesianIndices(inds::AbstractUnitRange{Int}) = CartesianIndices(axes(inds)) | ||
| CartesianIndices(inds::AbstractUnitRange{<:Integer}) = CartesianIndices(axes(inds)) | ||
| LinearIndices(inds::AbstractUnitRange{Int}) = LinearIndices(axes(inds)) | ||
| LinearIndices(inds::AbstractUnitRange{<:Integer}) = LinearIndices(axes(inds)) |
There was a problem hiding this comment.
Are these definitions correct? Fixes #26775 (comment) at least.
There was a problem hiding this comment.
Yes, should be OK to work around the deprecation.
|
Tests pass locally and doc building works on this branch. Failures are now only #27041 |
|
Failures are indeed due to |
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.
fix #26775 (comment)