From cf7ce16c3d3c4eaf088edb48ef95e83cd38a7216 Mon Sep 17 00:00:00 2001 From: Alain Emilia Anna Zscheile Date: Fri, 3 Jan 2025 06:07:58 +0100 Subject: [PATCH] docs(geometry/edit): document Recordable --- src/geometry/edit.rs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/geometry/edit.rs b/src/geometry/edit.rs index a487320..925bdb3 100644 --- a/src/geometry/edit.rs +++ b/src/geometry/edit.rs @@ -89,6 +89,10 @@ impl< } } +/// Recordable objects are objects to which a [recorder](`GeometryEdit`) can be attached, +/// the specialized methods working on `&mut` [`Recording`] then (are to be expected to) +/// also write changes to the passed `recorder`, and can also be replayed or rolled back +/// via [`ApplyGeometryEdit`]. pub trait Recordable { type PW: GetWidth + GetLayer