mirror of
https://github.com/JuliaFEM/JuliaFEM.jl.git
synced 2026-09-19 09:54:55 +00:00
Jukka Aho
b9fafd4e09
Consolidate topology module by merging topology.jl into api.jl and significantly simplify documentation across all topology files. Remove verbose docstrings, examples, and design notes in favor of minimal, code-focused documentation. Major changes: - Merge topology.jl into api.jl (delete topology.jl) - Simplify docstrings in api.jl, triangles.jl, and tetrahedra.jl - Remove verbose documentation from type aliases and functions - Remove topology type parameter from entity types (Vertex, Edge, Face, Cell) - Update all entity constructors to remove topology parameter - Add entities dispatcher and helper functions to api.jl File changes: - api.jl: Simplified AbstractTopology docstring, added topological entities and helpers from topology.jl, added entities dispatcher - triangles.jl: Removed verbose documentation - tetrahedra.jl: Removed verbose documentation - hexahedra.jl, pyramids.jl, quadrilaterals.jl, segments.jl, wedges.jl: Updated entity constructors to remove topology type parameter - topology.jl: Deleted (content moved to api.jl) Documentation philosophy: - Keep docstrings minimal and code-focused - Remove examples unless function use is unclear - Move comprehensive documentation to website/docs, not in code - Maintain essential type information and interface requirements