From c7c8d645573e01c7281df0430d1bd1737b080736 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rapha=C3=ABl=20Proust?= Date: Wed, 20 Feb 2019 14:03:44 +0800 Subject: [PATCH] Error Monad: improve docstring to register_error_kind --- src/lib_error_monad/error_monad_sig.ml | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/src/lib_error_monad/error_monad_sig.ml b/src/lib_error_monad/error_monad_sig.ml index 784988a43..63f788cce 100644 --- a/src/lib_error_monad/error_monad_sig.ml +++ b/src/lib_error_monad/error_monad_sig.ml @@ -67,11 +67,10 @@ module type S = sig (** The error data type is extensible. Each module can register specialized error serializers [id] unique name of this error. Ex.: overflow_time_counter - [title] human readable description. Ex.: The time counter overflown while computing delta increase - [description] formatter use to pretty print additional arguments. Ex.: The time counter overflown while computing delta increase. Previsous value %d. Delta: %d - [pp] data encoding for this error. If the error has no value, specify Data_encoding.empty - [encoder] - [decoder] + [title] more readable name. Ex.: Overflow of time counter + [description] human readable description. Ex.: The time counter overflowed while computing delta increase + [pp] formatter used to pretty print additional arguments. Ex.: The time counter overflowed while computing delta increase. Previous value %d. Delta: %d + [encoder] [decoder] data encoding for this error. If the error has no value, specify Data_encoding.empty *) val register_error_kind : error_category ->