diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-05-28 08:47:13 +0200 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-05-28 10:38:24 +0200 |
| commit | f4eac199703b54a594f836544e994640b8b91464 (patch) | |
| tree | 4d47c8ab0e51f1ccfc26eec02b54c83ea1e7767d /spec/spec/interface-description.yml | |
| parent | adb6e234fb9c973ad0febf23fe9f7e4238e7e8d8 (diff) | |
spec: Reuse interface description and notes
Diffstat (limited to 'spec/spec/interface-description.yml')
| -rw-r--r-- | spec/spec/interface-description.yml | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/spec/spec/interface-description.yml b/spec/spec/interface-description.yml index c940b766..07f8f998 100644 --- a/spec/spec/interface-description.yml +++ b/spec/spec/interface-description.yml @@ -11,7 +11,11 @@ spec-info: none: null str: description: | - It shall be the description of the interface. + It shall be the description of the interface. The description should be + short and concentrate on the average case. All special cases, usage + notes, constraints, error conditions, configuration dependencies, + references, etc. should be described in the + ${interface-notes:/spec-name}. spec-name: Interface Description spec-type: interface-description type: spec |