Skip to content

Commit 3ecaa82

Browse files
Merge pull request #937 from github/lcartey/add-missing-help-template
Create misra-c++-2023-help.md.template
2 parents 691460a + d078e04 commit 3ecaa82

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# {{ rule_id }}: {{ name }}
2+
3+
This query implements the {{ standard_name | escape }} rule {{ rule_id | escape }}:
4+
5+
> {{ rule_title }}
6+
7+
## Classification
8+
9+
** REPLACE THIS WITH THE CORRECT CLASSIFICATION **
10+
* required
11+
* implementation
12+
* automated
13+
14+
## Rationale
15+
16+
**REPLACE THIS WITH RATIONAL, IF ANY**
17+
18+
## Exception
19+
20+
**REPLACE THIS WITH EXCEPTION, IF ANY**
21+
22+
## Example
23+
24+
```cpp
25+
// REPLACE THIS WITH C++ EXAMPLE, IF ANY
26+
```
27+
28+
## See more
29+
30+
** REPLACE THIS WITH THE ANY SEE MORE REFERENCES **
31+
32+
## Implementation notes
33+
34+
{% if implementation_scope is defined %}
35+
{{ implementation_scope["description"] }}
36+
{% if implementation_scope["items"] is iterable %}
37+
{% for implementation_scope_entry in implementation_scope["items"] %}
38+
* {{ implementation_scope_entry }}
39+
{% endfor %}
40+
{% endif %}
41+
{% else %}
42+
None
43+
{% endif %}
44+
45+
## References
46+
47+
{% if standard_title | length %}
48+
* {{ standard_title | escape }}: [{{ rule_id }}: {{ rule_title }}]({{ standard_url }})
49+
{% endif %}

0 commit comments

Comments
 (0)