Ferrite-FEM / Ferrite.jl

Finite element toolbox for Julia
https://ferrite-fem.github.io
Other
339 stars 87 forks source link

Naming of reference shape in docs #946

Open KnutAM opened 3 months ago

KnutAM commented 3 months ago

As discovered in #935, we currently denote AbstractRefShape in the docs as

I would suggest to make this consistent throughout the docs in a pure rename PR, and since the type is AbstractRefShape suggest using the first name consistently.

termi-official commented 3 months ago

Related to this, so I answer here. Maybe we should add in the nomenclature section (xref https://github.com/Ferrite-FEM/Ferrite.jl/issues/944) and maybe in the beginning the relation between the wordings, as newcomers might wonder about why we do not call everything Element in the finite element method.