Skip to content

Commit c08c6a4

Browse files
rcseacordfelix91gr
andauthored
Update conf.py to add some tags and update the description of some existing tags (#238)
* Update conf.py add some new tags and update the descriptions of some existing tags * Update src/conf.py Co-authored-by: Félix Fischer <felix91gr@users.noreply.github.com> --------- Co-authored-by: Félix Fischer <felix91gr@users.noreply.github.com>
1 parent 4543086 commit c08c6a4

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

src/conf.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,17 +101,20 @@
101101

102102
needs_tags = [
103103
dict(name="security", description="Security-related guideline"),
104+
dict(name="safety", description="The degree to which a product or system avoids endangering human life, health, property, or the environment under defined operating conditions."),
104105
dict(name="performance", description="Performance-related guideline"),
105106
dict(name="readability", description="Readability-related guideline"),
107+
dict(name="understandability", description="Understandability is a sub-characteristic of usability in the ISO/IEC 25000 quality model, which measures how easy it is for users to understand the functions and usage of a software product. It is also a separate quality characteristic for data, referring to how well data can be read and interpreted by users with the help of appropriate languages, symbols, and units."),
106108
dict(name="reduce-human-error", description="Guideline that helps prevent human error"),
107109
dict(name="numerics", description="Numerics-related guideline"),
108110
dict(name="undefined-behavior", description="Guideline related to Undefined Behavior"),
109111
dict(name="stack-overflow", description="Guideline related to Stack Overflow"),
110112

111-
dict(name="maintainability", description="Maintainability-related guideline"),
112-
dict(name="portability", description="Portability-related guideline"),
113+
dict(name="maintainability", description="How effectively and efficiently a product or system can be modified. This includes improvements, fault corrections, and adaptations to changes in the environment or requirements. It is considered a crucial software quality characteristic."),
114+
dict(name="portability", description="The degree to which a system, product, or component can be effectively and efficiently transferred from one hardware, software, or other operational or usage environment to another."),
113115
dict(name="surprising-behavior", description="Guideline related to surprising or unexpected behavior"),
114116

117+
dict(name="types", description="Guideline associated with the correct use of types"),
115118
dict(name="subset", description="Guideline associated with the language-subset profile"),
116119
dict(name="defect", description="Guideline associated with the defect-prevention profile"),
117120
]

0 commit comments

Comments
 (0)