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

Error Monad: improve docstring to register_error_kind

Browse Source
This commit is contained in:
Raphaël Proust 2019-02-20 14:03:44 +08:00
parent 3776e6853d
commit c7c8d64557
No known key found for this signature in database
GPG Key ID: F4B685504488CEC0
1 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/lib_error_monad/error_monad_sig.ml
View File

@ -67,11 +67,10 @@ module type S = sig
(** The error data type is extensible. Each module can register specialized (** The error data type is extensible. Each module can register specialized
error serializers error serializers
[id] unique name of this error. Ex.: overflow_time_counter [id] unique name of this error. Ex.: overflow_time_counter
[title] human readable description. Ex.: The time counter overflown while computing delta increase [title] more readable name. Ex.: Overflow of time counter
[description] formatter use to pretty print additional arguments. Ex.: The time counter overflown while computing delta increase. Previsous value %d. Delta: %d [description] human readable description. Ex.: The time counter overflowed while computing delta increase
[pp] data encoding for this error. If the error has no value, specify Data_encoding.empty [pp] formatter used to pretty print additional arguments. Ex.: The time counter overflowed while computing delta increase. Previous value %d. Delta: %d
[encoder] [encoder] [decoder] data encoding for this error. If the error has no value, specify Data_encoding.empty
[decoder]
*) *)
val register_error_kind : val register_error_kind :
error_category -> error_category ->