From 6b679245f35cdc66481f7b01a0811eba39e812de Mon Sep 17 00:00:00 2001
From: Anders Lau Olsen
Date: Wed, 11 Apr 2012 14:47:14 +0200
Subject: [PATCH] API doc.
Emphasize how [intermediary_steps] should be used as a constructor.
---
src/PaplInterpolate.mli | 9 ++++-----
1 file changed, 4 insertions(+), 5 deletions(-)
diff --git a/src/PaplInterpolate.mli b/src/PaplInterpolate.mli
index 41357cd..7cbcf37 100644
--- a/src/PaplInterpolate.mli
+++ b/src/PaplInterpolate.mli
@@ -32,12 +32,11 @@ type 'a intermediary_t = 'a -> 'a -> 'a BatEnum.t
val intermediary_steps :
'a t -> 'a PaplMetric.threshold_t -> 'a intermediary_t
-(**
- [intermediary_steps ip (metric, eps) a b] are the intermediary steps of
- length [eps] connecting [a] to [b].
+(** If [it = intermediary_steps ip (metric, eps)] then [it a b] are the
+ intermediary steps of length [eps] connecting [a] to [b].
- [a] and [b] are not explicitly included in the stream (but they can be if the
- interpolation function [ip] happens to return them).
+ [a] and [b] are not explicitly included in the stream (but they can be if
+ the interpolation function [ip] happens to return them).
*)
(** {2 Float planning space} *)
--
2.1.1