Update some missing Lagrange docs #889
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #889 +/- ##
=======================================
Coverage 93.30% 93.30%
=======================================
Files 36 36
Lines 5257 5257
=======================================
Hits 4905 4905
Misses 352 352 ☔ View full report in Codecov by Sentry. |
| @@ -86,7 +86,7 @@ In this space a local numbering of nodes and faces exists, i.e. | |||
| The example shows a local face ID ordering, defined as: | |||
|
|
|||
| ```julia | |||
| faces(::Lagrange{2,RefCube,1}) = ((1,2), (2,3), (3,4), (4,1)) | |||
| faces(::Lagrange{RefQuadrilateral,1}) = ((1,2), (2,3), (3,4), (4,1)) | |||
| ``` | |||
|
|
|||
| Other face ID definitions [can be found in the src files](https://github.com/Ferrite-FEM/Ferrite.jl/blob/8224282ab4d67cb523ef342e4a6ceb1716764ada/src/interpolations.jl#L154) in the corresponding `faces` dispatch. | |||
There was a problem hiding this comment.
Sidenote: Should this really point to a specific commit? (The current one points to a commit made 5 years ago...)
There was a problem hiding this comment.
No, but we do not have docs for these yet. #689 maybe? Also, this doc must be specified further. I just remembered that faces does not exist anymore for interpolations (and that this doc string was a bit misleading in first place).
There was a problem hiding this comment.
facesdoes not exist anymore for interpolations
What do you mean? On master e.g. Ferrite.faces(Lagrange{RefQuadrilateral,1}()) works fine?
There was a problem hiding this comment.
There was a problem hiding this comment.
It is really tricky with those deprecations since we don't see anything unless running tests (or explicitly asking for depwarn) - since many users will just run scripts, would it perhaps be better to give an explicit warning?
Sorry for spamming this PR, but just to save the idea in case this could be a valuable pattern, what about
function foo(::AbstractFloat)
println("Allowed")
end
@generated function foo(v::Integer)
@warn "Calling foo(::Integer) is deprecated"
return :(println("Was allowed before"))
endGiving
julia> foo(1.)
Allowed
julia> foo(1)
┌ Warning: Calling foo(::Integer) is deprecated
└ @ Main REPL[11]:2
Was allowed before
julia> foo(1)
Was allowed before
CC @fredrikekre
Co-authored-by: Knut Andreas Meyer <knutam@gmail.com>
No description provided.