2927

Committed 17 Mar 2025 05:09PM UTC coverage: 73.273% (-0.1%) from 73.372%

Build # 2927

Build Type

push

github

Committed by

jonludlam

Commit Message

Parser: Ensure parser can be called concurrently

Run Details

10393 of 14184 relevant lines covered (73.27%)

9819.54 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

96.88

/src/parser/parse_error.ml

let capitalize_ascii = Astring.String.Ascii.capitalize

let bad_markup : ?suggestion:string -> string -> Loc.span -> Warning.t =
 fun ?suggestion -> Warning.make ?suggestion "'%s': bad markup."

let leading_zero_in_heading_level : string -> Loc.span -> Warning.t =
  Warning.make "'%s': leading zero in heading level."

let should_not_be_empty : what:string -> Loc.span -> Warning.t =
 fun ~what -> Warning.make "%s should not be empty." (capitalize_ascii what)

let markup_should_not_be_used : what:string -> Loc.span -> Warning.t =
 fun ~what ->
  Warning.make "%s should not be used because it has no effect."
    (capitalize_ascii what)

let should_begin_on_its_own_line : what:string -> Loc.span -> Warning.t =
 fun ~what ->
  Warning.make "%s should begin on its own line." (capitalize_ascii what)

let should_be_followed_by_whitespace : what:string -> Loc.span -> Warning.t =
 fun ~what ->
  Warning.make "%s should be followed by space, a tab, or a new line."
    (capitalize_ascii what)

let not_allowed :
    ?suggestion:string -> what:string -> in_what:string -> Loc.span -> Warning.t
    =
 fun ?suggestion ~what ~in_what ->
  Warning.make ?suggestion "%s is not allowed in %s." (capitalize_ascii what)
    in_what

let unclosed_bracket :
    ?suggestion:string -> bracket:string -> Loc.span -> Warning.t =
 fun ?suggestion ~bracket ->
  Warning.make ?suggestion "Open bracket '%s' is never closed." bracket

let no_leading_whitespace_in_verbatim : Loc.span -> Warning.t =
  Warning.make "'{v' should be followed by whitespace."

let not_enough_indentation_in_code_block : what:string -> Loc.span -> Warning.t
    =
 fun ~what ->
  Warning.make "%ss should be indented at the opening `{`."
    (String.capitalize_ascii what)

let no_trailing_whitespace_in_verbatim : Loc.span -> Warning.t =
  Warning.make "'v}' should be preceded by whitespace."

let stray_at : Loc.span -> Warning.t = Warning.make "Stray '@'."

let stray_cr : Loc.span -> Warning.t =
  Warning.make "Stray '\\r' (carriage return character)."

let truncated_before : Loc.span -> Warning.t =
  Warning.make "'@before' expects version number on the same line."

let truncated_param : Loc.span -> Warning.t =
  Warning.make "'@param' expects parameter name on the same line."

let truncated_raise : string -> Loc.span -> Warning.t =
  Warning.make "'%s' expects exception constructor on the same line."

let truncated_see : Loc.span -> Warning.t =
  Warning.make
    "'@see' should be followed by <url>, 'file', or \"document title\"."

let truncated_string : Loc.span -> Warning.t =
  Warning.make "Truncated string literal"

let unknown_tag : string -> Loc.span -> Warning.t =
  Warning.make "Unknown tag '%s'."

let unpaired_right_brace : Loc.span -> Warning.t =
  Warning.make ~suggestion:"try '\\}'." "Unpaired '}' (end of markup)."

let unpaired_right_bracket : Loc.span -> Warning.t =
  Warning.make ~suggestion:"try '\\]'." "Unpaired ']' (end of code)."

let no_language_tag_in_meta : Loc.span -> Warning.t =
  Warning.make ~suggestion:"try '{[ ... ]}' or '{@ocaml[ ... ]}'."
    "'{@' should be followed by a language tag."

let language_tag_invalid_char lang_tag : char -> Loc.span -> Warning.t =
  let suggestion = "try '{@" ^ lang_tag ^ "[ ... ]}'." in
  Warning.make ~suggestion "Invalid character '%c' in language tag."

let code_block_tag_invalid_char : char -> Loc.span -> Warning.t =
  Warning.make "Invalid character in code block metadata tag '%c'."

let invalid_char_code : int -> Loc.span -> Warning.t =
  Warning.make "Invalid escape sequence '\\%d"

let truncated_code_block_meta : Loc.span -> Warning.t =
  Warning.make ~suggestion:"try '{@ocaml[ ... ]}'." "Missing end of code block."

let truncated_code_block : Loc.span -> Warning.t =
  Warning.make ~suggestion:"add ']}'." "Missing end of code block."

let end_not_allowed : in_what:string -> Loc.span -> Warning.t =
 fun ~in_what ->
  Warning.make ~suggestion:"add '}'." "End of text is not allowed in %s."
    in_what

let should_not_be_escaped : char -> Loc.span -> Warning.t =
 fun c ->
  Warning.make ~suggestion:"Remove \\."
    "The '%c' character should not be escaped." c

1	let capitalize_ascii = Astring.String.Ascii.capitalize
2
3	let bad_markup : ?suggestion:string -> string -> Loc.span -> Warning.t =
4	fun ?suggestion -> Warning.make ?suggestion "'%s': bad markup."	15✔
5
6	let leading_zero_in_heading_level : string -> Loc.span -> Warning.t =
7	Warning.make "'%s': leading zero in heading level."	1,232✔
8
9	let should_not_be_empty : what:string -> Loc.span -> Warning.t =
10	fun ~what -> Warning.make "%s should not be empty." (capitalize_ascii what)	59✔
11
12	let markup_should_not_be_used : what:string -> Loc.span -> Warning.t =
13	fun ~what ->
14	Warning.make "%s should not be used because it has no effect."	3✔
15	(capitalize_ascii what)	3✔
16
17	let should_begin_on_its_own_line : what:string -> Loc.span -> Warning.t =
18	fun ~what ->
19	Warning.make "%s should begin on its own line." (capitalize_ascii what)	35✔
20
21	let should_be_followed_by_whitespace : what:string -> Loc.span -> Warning.t =
22	fun ~what ->
23	Warning.make "%s should be followed by space, a tab, or a new line."	8✔
24	(capitalize_ascii what)	8✔
25
26	let not_allowed :
27	?suggestion:string -> what:string -> in_what:string -> Loc.span -> Warning.t
28	=
29	fun ?suggestion ~what ~in_what ->
30	Warning.make ?suggestion "%s is not allowed in %s." (capitalize_ascii what)	64✔
31	in_what
32
33	let unclosed_bracket :
34	?suggestion:string -> bracket:string -> Loc.span -> Warning.t =
35	fun ?suggestion ~bracket ->
36	Warning.make ?suggestion "Open bracket '%s' is never closed." bracket	19✔
37
38	let no_leading_whitespace_in_verbatim : Loc.span -> Warning.t =
39	Warning.make "'{v' should be followed by whitespace."	1,232✔
40
41	let not_enough_indentation_in_code_block : what:string -> Loc.span -> Warning.t
42	=
43	fun ~what ->
44	Warning.make "%ss should be indented at the opening `{`."	6✔
45	(String.capitalize_ascii what)	6✔
46
47	let no_trailing_whitespace_in_verbatim : Loc.span -> Warning.t =
48	Warning.make "'v}' should be preceded by whitespace."	1,232✔
49
50	let stray_at : Loc.span -> Warning.t = Warning.make "Stray '@'."	1,232✔
51
52	let stray_cr : Loc.span -> Warning.t =
53	Warning.make "Stray '\\r' (carriage return character)."	1,232✔
54
55	let truncated_before : Loc.span -> Warning.t =
56	Warning.make "'@before' expects version number on the same line."	1,232✔
57
58	let truncated_param : Loc.span -> Warning.t =
59	Warning.make "'@param' expects parameter name on the same line."	1,232✔
60
61	let truncated_raise : string -> Loc.span -> Warning.t =
62	Warning.make "'%s' expects exception constructor on the same line."	1,232✔
63
64	let truncated_see : Loc.span -> Warning.t =
65	Warning.make	1,232✔
66	"'@see' should be followed by <url>, 'file', or \"document title\"."
67
68	let truncated_string : Loc.span -> Warning.t =
69	Warning.make "Truncated string literal"	1,232✔
70
71	let unknown_tag : string -> Loc.span -> Warning.t =
72	Warning.make "Unknown tag '%s'."	1,232✔
73
74	let unpaired_right_brace : Loc.span -> Warning.t =
75	Warning.make ~suggestion:"try '\\}'." "Unpaired '}' (end of markup)."	1,232✔
76
77	let unpaired_right_bracket : Loc.span -> Warning.t =
78	Warning.make ~suggestion:"try '\\]'." "Unpaired ']' (end of code)."	1,232✔
79
80	let no_language_tag_in_meta : Loc.span -> Warning.t =
81	Warning.make ~suggestion:"try '{[ ... ]}' or '{@ocaml[ ... ]}'."	1,232✔
82	"'{@' should be followed by a language tag."
83
84	let language_tag_invalid_char lang_tag : char -> Loc.span -> Warning.t =
85	let suggestion = "try '{@" ^ lang_tag ^ "[ ... ]}'." in	×
86	Warning.make ~suggestion "Invalid character '%c' in language tag."
87
88	let code_block_tag_invalid_char : char -> Loc.span -> Warning.t =
89	Warning.make "Invalid character in code block metadata tag '%c'."	1,232✔
90
91	let invalid_char_code : int -> Loc.span -> Warning.t =
92	Warning.make "Invalid escape sequence '\\%d"	1,232✔
93
94	let truncated_code_block_meta : Loc.span -> Warning.t =
95	Warning.make ~suggestion:"try '{@ocaml[ ... ]}'." "Missing end of code block."	1,232✔
96
97	let truncated_code_block : Loc.span -> Warning.t =
98	Warning.make ~suggestion:"add ']}'." "Missing end of code block."	1,232✔
99
100	let end_not_allowed : in_what:string -> Loc.span -> Warning.t =
101	fun ~in_what ->
102	Warning.make ~suggestion:"add '}'." "End of text is not allowed in %s."	16✔
103	in_what
104
105	let should_not_be_escaped : char -> Loc.span -> Warning.t =
106	fun c ->
107	Warning.make ~suggestion:"Remove \\."	7✔
108	"The '%c' character should not be escaped." c

ocaml / odoc / 2927

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous