Improve Code documentation #71
Conversation
There was a problem hiding this comment.
Bitte sei noch so gut und vereinheitliche die Beispiele. Du verwendest 3 verschiende Quotes wild gemischt für die Viertel-Tags:
´<C_xxxx´
mit zwei Forward Ticks
"<AWF"
mit zwei double quotes
`<AHB´
mit back tick und forward tick.
Ich wäre für konsistent nur backticks.
Zugegeben war das bei den deutschen Begriffen vorher auch schon ein Mix aus single und double quotes. Aber wenn wir eh drüber gehen, dann doch am besten gleich einheitlich alles machen.
| A "Segmentgruppe" inside an AHB, indicated by the ´<G_xxxx´ tag. | ||
| This model can contain both Segments and segment groups. |
There was a problem hiding this comment.
ist das nicht sogar: G_SG?
zumindest für UTILTS und UTILMD ist das so:
oder es klappt nur zufällig ;)
| status_std: MigStatus # e.g. M | ||
| status_specification: MigStatus # e.g. M |
There was a problem hiding this comment.
hier hätte der mehrwert imho eher darin gelegen, das man die einzelne enum Members von MigStatus dokumentiert statt hier den ersten member als beispiel zu ergänzen.
No description provided.