From 06d6be33dfe092d4ac1dc01e85bd5f849c62442d Mon Sep 17 00:00:00 2001 From: Jukka Aho Date: Tue, 18 Nov 2025 15:09:09 +0200 Subject: [PATCH] docs(api): Reflow API design documentation and add spacing for readability - Insert blank lines around headings and list items for better rendering - Clarify pattern notes: zero-duplication, domain ownership, minimal core - Improve example spacing so code fences render correctly in generated docs No code changes; only formatting and readability improvements to the API documentation. --- src/api.jl | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/api.jl b/src/api.jl index 66e90eb..35d6782 100644 --- a/src/api.jl +++ b/src/api.jl @@ -56,25 +56,32 @@ in a dedicated `api.jl` file: # Design Philosophy **Zero Duplication:** + Each abstract type is defined in exactly ONE place. No type appears in multiple api.jl files. **Domain Ownership:** + Each domain owns its abstractions. Want to know about materials? Look in src/materials/api.jl. Want to know about meshes? Look in src/mesh/api.jl. **Minimal Core:** + This file (src/api.jl) contains NO type definitions - only documentation. All abstractions live in their domain-specific api.jl files. **Clear Boundaries:** + Each api.jl file documents: + - What types it defines - What interfaces it declares - What belongs in that domain - What does NOT belong (and where to find it) **Systematic Pattern:** + All domains follow identical structure: + - Abstract base types - Interface function stubs - Comprehensive documentation with examples