balsoft/ligo
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Error Monad: add docstring to register_error_kind

Browse Source
This commit is contained in:
Pietro Abate 2018-10-29 10:33:42 +01:00 committed by Raphaël Proust
parent 5f378c8ba0
commit 3776e6853d
No known key found for this signature in database
GPG Key ID: F4B685504488CEC0
1 changed files with 14 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
src/lib_error_monad/error_monad_sig.ml
View File

@ -64,13 +64,24 @@ module type S = sig
(** {2 Error classification} ***********************************************)
(** For other modules to register specialized error serializers *)
(** 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]
*)
val register_error_kind :
error_category ->
id:string -> title:string -> description:string ->
id:string ->
title:string ->
description:string ->
?pp:(Format.formatter -> 'err -> unit) ->
'err Data_encoding.t ->
(error -> 'err option) -> ('err -> error) ->
(error -> 'err option) ->
('err -> error) ->
unit
(** Classify an error using the registered kinds *)