From d7e9c3cc46d616c2fcd1a6e9f73adbb79c6570b4 Mon Sep 17 00:00:00 2001
From: Arne Dußin
Date: Mon, 21 Dec 2020 01:22:15 +0100
Subject: Add previously missing docs where appropriate

---
 src/transformable.rs | 9 +++++++++
 1 file changed, 9 insertions(+)

(limited to 'src/transformable.rs')

diff --git a/src/transformable.rs b/src/transformable.rs
index c181bd6..b8212f9 100644
--- a/src/transformable.rs
+++ b/src/transformable.rs
@@ -1,3 +1,12 @@
+//! Traits for items that can be modified using a variety of matrix transformations.
+//!
+//! Items in the world may be resizable or rotateable etc. in a variety of different ways. This
+//! module contains the traits that are used to interact with such objects in a way, that ensures the
+//! item is not transformed illegaly. For example, an item may be scaleable by a factor, but that does
+//! not necessarily mean that it can be scaled by different factors in x and y direction (stretched).
+//! If need be, this module contains the different types of transformations and transformation
+//! restrictions to make these features available and restricting them reliably.
+
 use nalgebra::Matrix3;
 
 /// Trait for things that can be stretched and rotated etc. as one pleases without
-- 
cgit v1.2.3-70-g09d2