Skip to content

Commit 1f81678

Browse files
committed
Update macro coding guideline to fit compliant / non-compliant change and new options
1 parent c28462c commit 1f81678

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

src/coding-guidelines/macros.rst

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,12 @@ Macros
88

99
.. guideline:: Avoid specialized, fixed patterns within declarative macros
1010
:id: gui_FSpI084vbwmJ
11+
:category: required
1112
:status: draft
1213
:fls: fls_w44hav7mw3ao
14+
:decidability: decidable
15+
:scope: module
1316
:tags: reduce-human-error
14-
:category: macros
15-
:recommendation: encouraged
1617

1718
Description of the guideline goes here.
1819

@@ -31,8 +32,8 @@ Macros
3132
If needing to specialize logic within the macro based on a particular
3233
expression's value, it may be better to not use a declarative macro.
3334

34-
.. bad_example::
35-
:id: bad_ex_5vK0CCmePkef
35+
.. non_compliant_example::
36+
:id: non_compl_ex_5vK0CCmePkef
3637
:status: draft
3738

3839
We have two macro match rules at the same level of nesting. Since the
@@ -88,8 +89,8 @@ Macros
8889
impl_safety_trait!(PressureSensor);
8990
impl_safety_trait!(TemperatureSensor);
9091
91-
.. good_example::
92-
:id: good_ex_ILBlY8DKB6Vs
92+
.. compliant_example::
93+
:id: compl_ex_ILBlY8DKB6Vs
9394
:status: draft
9495

9596
For the specialized implementation we implement the trait directly.

0 commit comments

Comments
 (0)