Skip to content

Commit 8d3e077

Browse files
author
Stefan Cyliax
committed
doc: changed modal verbs chapter to ASAM version
Signed-off-by: Stefan Cyliax <stefan.cyliax@asam.net>
1 parent 16ad315 commit 8d3e077

1 file changed

Lines changed: 1 addition & 35 deletions

File tree

general_docs/conventions.adoc

Lines changed: 1 addition & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -6,41 +6,7 @@ Every field has its own unit that is defined in the proto files.
66
For more information, see <<_commenting_on_fields_and_enums, the example in the contribution guidelines.>>
77

88
[#sec-273d9649-afab-45d3-b6c9-73c0e64971a0]
9-
== Modal verbs
10-
11-
To ensure compliance with the Open Simulation Interface standard, users need to be able to distinguish between mandatory requirements, recommendations, permissions, as well as possibilities and capabilities.
12-
13-
The following rules for using modal verbs apply:
14-
15-
.Rules for using modal verbs
16-
[%header, cols=2*]
17-
|===
18-
|Provision |Verbal form
19-
|*Requirement* +
20-
Requirements shall be followed strictly in order to be conform to the standard. Deviations are not allowed.
21-
|shall +
22-
shall not
23-
24-
|*Recommendation* +
25-
Recommendations indicate that one possibility out of the several available is particularly suitable, without mentioning or excluding the other possibilities.
26-
|should +
27-
should not
28-
29-
|*Permission* +
30-
Permissions indicate a course of action permissible within the limits of {THIS_STANDARD} deliverables.
31-
|may +
32-
need not
33-
34-
|*Possibility and capability* +
35-
Verbal forms used to state possibilities or capabilities, whether technical, material, physical, etc.
36-
|can +
37-
cannot
38-
39-
|*Obligation and necessity* +
40-
Verbal forms used to describe legal, organizational, or technical obligations and necessities that are not regulated or enforced by the {THIS_STANDARD} standard.
41-
|must +
42-
must not
43-
|===
9+
include::../{asciidoc-resources}/modal_verbs.adoc[leveloffset=+1]
4410

4511
== Typographic conventions
4612

0 commit comments

Comments
 (0)