aboutsummaryrefslogtreecommitdiff
path: root/kernel/names.mli
diff options
context:
space:
mode:
authorMaxime Dénès2017-05-23 09:12:02 +0200
committerMaxime Dénès2017-05-23 09:12:02 +0200
commit17e3f3b6a17145f7a51653de670263b7c3d613f3 (patch)
treef8a08cae32c7636f2d00405d43581530f262e2e7 /kernel/names.mli
parent3e5cbc1e5a18a21cd97c1077552314c84d59852e (diff)
parent5b218f87bd59cfe9d510410c9acf78b5485391e1 (diff)
Merge PR#646: Revised behavior on ill-formed identifiers
Diffstat (limited to 'kernel/names.mli')
-rw-r--r--kernel/names.mli5
1 files changed, 3 insertions, 2 deletions
diff --git a/kernel/names.mli b/kernel/names.mli
index be9b9422b7..5b0163aa55 100644
--- a/kernel/names.mli
+++ b/kernel/names.mli
@@ -46,11 +46,12 @@ sig
val of_bytes : bytes -> t
val of_string : string -> t
(** Converts a string into an identifier.
- @raise UserError if the string is not valid, or echo a warning if it contains invalid identifier characters.
+ @raise UserError if the string is invalid as an identifier.
@raise Unicode.Unsupported if the provided string contains unsupported UTF-8 characters. *)
val of_string_soft : string -> t
- (** Same as {!of_string} except that no warning is ever issued.
+ (** Same as {!of_string} except that any string made of supported UTF-8 characters is accepted.
+ @raise UserError if the string is invalid as an UTF-8 string.
@raise Unicode.Unsupported if the provided string contains unsupported UTF-8 characters. *)
val to_string : t -> string