Skip to content

Commit 672e629

Browse files
docs: improve wording to enhance clarity and readability in metamodel.md (#425)
1 parent f8e0176 commit 672e629

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

docs/internals/extensions/metamodel.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ needs_types:
9191
9292
### 2. Generic Graph Checks (Configuration-Based)
9393
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:
9595

9696
```yaml
9797
<name of the check>:
@@ -122,11 +122,11 @@ graph_checks:
122122
and:
123123
- safety != QM
124124
- 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.
126126
```
127127

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.
130130
If one of them does not fulfill the condition the check fails and will let you know with a warning that it did so.
131131

132132
### 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
165165
Ensure this check is inside a python file that is placed in the `check` folder in this extension.
166166
Do not forget to add the applicable decorator to the function.
167167

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.
169169

170170
Your function will receive the Sphinx `app`, the current `need` to check and a `log` to log messages.
171171

@@ -183,7 +183,7 @@ def my_local_check(app, need, log):
183183

184184
### 5. Custom Graph Checks (Python Code)
185185
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`.
187187

188188
```python
189189
from score_metamodel.checks import graph_check

0 commit comments

Comments
 (0)