Mention sized and friends in user manual

diagrams · Oct 16, 2012 · c5e726d · c5e726d
1 parent 6ba79f2
commit c5e726d
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/manual/diagrams-manual.rst b/manual/diagrams-manual.rst
@@ -2194,6 +2194,19 @@ Envelope-related functions
   information from the envelopes of two-dimensional diagrams,
   such as `width`, `height`, `extentX`, `extentY`, and `center2D`.
 
+  It also provides functions `sized` and `sizedAs`, which can be used
+  for changing the size of an object.  For example:
+
+  .. class:: dia-lhs
+
+  ::
+
+  > shapes = circle 1 
+  >      ||| square 2 
+  >      ||| circle # scaleY 0.3 # sizedAs (square 2)
+  >
+  > example = hrule 1 # sizedAs (shapes # scale 0.5) <> shapes # centerX
+
 The ``Enveloped`` class
 ~~~~~~~~~~~~~~~~~~~~~~~