-
Notifications
You must be signed in to change notification settings - Fork 42
/
CompilationMessage.yaml
35 lines (35 loc) · 1.08 KB
/
CompilationMessage.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
title: CompilationMessage
'@id': stencila:CompilationMessage
nick: cme
extends: Entity
category: code
status: alpha
description: An error, warning or log message generated during compilation.
required:
- level
- message
core:
- errorType
- codeLocation
properties:
level:
'@id': stencila:level
description: The severity level of the message.
$ref: MessageLevel
message:
'@id': stencila:message
description: The text of the message.
type: string
errorType:
'@id': stencila:errorType
description: The type of error e.g. "SyntaxError", "ZeroDivisionError".
$comment: |
Many languages have the concept of alternative types of errors.
For example, Python has various [classes of exceptions](https://docs.python.org/3/tutorial/errors.html).
This property is intended to be used for storing these type names as additional
information that maybe useful to the user attempting to resolve the error.
type: string
codeLocation:
'@id': stencila:codeLocation
description: The location that the error occurred.
$ref: CodeLocation