Skip to content

Commit fc7995b

Browse files
committed
Update after review comments
1 parent 56321c2 commit fc7995b

File tree

1 file changed

+13
-15
lines changed

1 file changed

+13
-15
lines changed

eeps/eep-0074.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,16 @@ EEP 74: Erlang Diagnostic Index
1212
Abstract
1313
========
1414

15-
The **Erlang Diagnostic Index** is a standardized way to _catalogue_
16-
errors/warnings/information messages emitted by various tools and applications
17-
within the Erlang ecosystem, including - but not limited to - the `erlc`
18-
Erlang compiler, the `dialyzer` type checker and the `ssl` application.
15+
The **Erlang Diagnostic Index** is a standardized way to catalogue
16+
diagnostic messages emitted by various tools and applications within the Erlang
17+
ecosystem, including - but not limited to - the `erlc` Erlang compiler,
18+
the `dialyzer` type checker and the `ssl` application.
1919

2020
The indexes are not limited to Erlang/OTP, but can also be used by third-parties
2121
such as the [Elixir] language, the [EqWAlizer] type-checker or the [Elvis]
2222
code style reviewer.
2323

24-
Each diagnostic in an index is identified by a **code** and it is accompanied
24+
Each diagnostic in an index is identified by a unique **code** and it is accompanied
2525
by a description, examples and possible courses of action. Diagnostic codes are
2626
_namespaced_ based on the tool that generates them.
2727

@@ -47,11 +47,10 @@ Producing meaningful error messages can sometimes be challenging for
4747
developer tools such as compilers and type checkers due to various
4848
constraints, including limited context and character count.
4949

50-
By associating a **unique code** to each _diagnostic_ (warning,
51-
error or information) we relieve tools from having to condense a
52-
lot of textual information into a - sometime cryptic - generic, single
53-
sentence. Furthermore, as specific wording of errors and warnings is
54-
improved over time, diagnostic codes remain constant, providing a
50+
By associating a **unique code** to each _diagnostic_ we relieve tools from
51+
having to condense a lot of textual information into a - sometime cryptic -
52+
generic, single sentence. Furthermore, as specific wording of errors and
53+
warnings is improved over time, diagnostic codes remain constant, providing a
5554
search-engine friendly way to index and reference diagnostics.
5655

5756
A good example of this is the _expression updates a literal_ warning
@@ -93,9 +92,8 @@ forums and chats, where the exact message could vary, but the diagnostic code
9392
would be the same.
9493

9594
Finally, diagnostic codes can be used by IDEs (e.g. via language servers)
96-
to match on diagnostic codes and provide contextual help. Both the [Erlang
97-
LS][] and the [ELP][] language server already use "unofficial" error
98-
codes.
95+
to match on diagnostic codes and provide contextual help. Both the [ErlangLS][]
96+
and the [ELP][] language server already use "unofficial" error codes.
9997

10098
Implementation
10199
==============
@@ -264,7 +262,7 @@ in order to get a similar look and feel throughout the community.
264262
````markdown
265263
# XYZ-ABCD - Short Title
266264

267-
## Error/Warning/Info
265+
## Example
268266

269267
```
270268
Short example producing the error/warning/info
@@ -282,7 +280,7 @@ For example:
282280
````markdown
283281
# ERL-0001 - Function head mismatch
284282

285-
## Error example
283+
## Example
286284

287285
```erlang
288286
%% foo.erl

0 commit comments

Comments
 (0)