[MLton-commit] r4873

[Vesa K. <ve...@ml...>]

Doc tweaks.
----------------------------------------------------------------------

U   mltonlib/trunk/com/ssh/extended-basis/unstable/public/char.sig
U   mltonlib/trunk/com/ssh/extended-basis/unstable/public/emb.sig
U   mltonlib/trunk/com/ssh/extended-basis/unstable/public/exn.sig

----------------------------------------------------------------------

Modified: mltonlib/trunk/com/ssh/extended-basis/unstable/public/char.sig
===================================================================
--- mltonlib/trunk/com/ssh/extended-basis/unstable/public/char.sig	2006-11-29 13:22:33 UTC (rev 4872)
+++ mltonlib/trunk/com/ssh/extended-basis/unstable/public/char.sig	2006-11-29 17:56:14 UTC (rev 4873)
@@ -4,23 +4,17 @@
  * See the file MLton-LICENSE for details.
  *)
 
-(**
- * Extended {CHAR} signature.
- *)
+(** Extended {CHAR} signature. *)
 signature CHAR = sig
    include CHAR
 
    type t = char
-   (**
-    * Convenience alias.
-    *)
+   (** Convenience alias. *)
 
    (** == Bounds == *)
 
    val minOrd : Int.t
-   (**
-    * The least character code.  It always equals {0}.
-    *)
+   (** The least character code.  It always equals {0}. *)
 
    val boundsChar : t Sq.t
    (**

Modified: mltonlib/trunk/com/ssh/extended-basis/unstable/public/emb.sig
===================================================================
--- mltonlib/trunk/com/ssh/extended-basis/unstable/public/emb.sig	2006-11-29 13:22:33 UTC (rev 4872)
+++ mltonlib/trunk/com/ssh/extended-basis/unstable/public/emb.sig	2006-11-29 17:56:14 UTC (rev 4873)
@@ -7,13 +7,10 @@
 (** Signature for the {Emb} structure for embeddings. *)
 signature EMB = sig
    type ('a, 'b) t = ('a -> 'b) * ('b -> 'a Option.t)
-   (** Embedding of {'a} into {'b} with injection and projection functions. *)
+   (** Witness to an embedding of {'a} into {'b}. *)
 
    val id : ('a, 'a) t
-   (**
-    * The identity embedding.  This is always equivalent to {(fn a => a,
-    * SOME)}.
-    *)
+   (** The identity embedding.  This is always equivalent to {(id, SOME)}. *)
 
    val to : ('a, 'b) t -> 'a -> 'b
    (** Extracts the injection part of the given embedding. *)

Modified: mltonlib/trunk/com/ssh/extended-basis/unstable/public/exn.sig
===================================================================
--- mltonlib/trunk/com/ssh/extended-basis/unstable/public/exn.sig	2006-11-29 13:22:33 UTC (rev 4872)
+++ mltonlib/trunk/com/ssh/extended-basis/unstable/public/exn.sig	2006-11-29 17:56:14 UTC (rev 4873)
@@ -7,6 +7,7 @@
 (** Utilities for dealing with exceptions. *)
 signature EXN = sig
    type t = exn
+   (** Convenience alias. *)
 
    val addMessager : (t -> String.t Option.t) Effect.t
    (**