You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/internals/extensions/metamodel.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -91,7 +91,7 @@ needs_types:
91
91
92
92
### 2. Generic Graph Checks (Configuration-Based)
93
93
Generic graph checks are defined in the metamodel.yaml under `graph_checks`.
94
-
These checks all follow the same structure:
94
+
These checks follow the same structure:
95
95
96
96
```yaml
97
97
<name of the check>:
@@ -122,11 +122,11 @@ graph_checks:
122
122
and:
123
123
- safety != QM
124
124
- status == valid
125
-
explanation: An safety architecture element can only link other safety architecture elements.
125
+
explanation: A safety architecture element can only link other safety architecture elements.
126
126
```
127
127
128
-
What does this check do?
129
-
This check will go through each of the needs mentioned in 'include' that match the condition, and then for every single one of them check the needs that are linked inside the 'implements' attribute. Go inside those needs and check if they also fulfill the condition described.
128
+
Purpose of this check:
129
+
This check will go through each of the needs mentioned in 'include' that match the condition, and then for every single one of them check the needs that are linked inside the 'implements' attribute. Check whether those needs also fulfill the condition.
130
130
If one of them does not fulfill the condition the check fails and will let you know with a warning that it did so.
131
131
132
132
### 3. Prohibited Word Checks (Configuration-Based)
@@ -165,7 +165,7 @@ If you need something that the generic local or graph checks can not fulfill, th
165
165
Ensure this check is inside a python file that is placed in the `check` folder in this extension.
166
166
Do not forget to add the applicable decorator to the function.
167
167
168
-
This means all validations can be done with only the information in this need itself, and you do not need access to any of the linked needs or other needs inside the documentation.
168
+
This means all validations can be done using only the information within the need itself, and you do not need access to any of the linked needs or other needs inside the documentation.
169
169
170
170
Your function will receive the Sphinx `app`, the current `need` to check and a `log` to log messages.
171
171
@@ -183,7 +183,7 @@ def my_local_check(app, need, log):
183
183
184
184
### 5. Custom Graph Checks (Python Code)
185
185
These checks need to access linked needs in order to fully verify the specified behavior.
186
-
The signature is similar to that of local_check, but instead of one need you will get `all_needs`.
186
+
The signature is similar to that of local_check, but instead of one need, you will get `all_needs`.
0 commit comments