Skip to content

Commit 1edbf77

Browse files
committed
docs(standard): make genericName optional and deprecate it
genericName doesn't really fit software outside Desktop environments and is often misused in practice. Also, we don't offer any controlled vocabulary for generic names. The 'shortDescription' and 'name' keys are good enough. Fix #59.
1 parent 7ecff80 commit 1edbf77

3 files changed

Lines changed: 3 additions & 5 deletions

File tree

docs/standard/example/publiccode.minimal.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ softwareType: "standalone/desktop"
1717
description:
1818
en:
1919
localisedName: medusa # Optional
20-
genericName: Text Editor
2120
shortDescription: >
2221
A rather short description which
2322
is probably useless

docs/standard/example/publiccode.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,6 @@ intendedAudience:
4545
description:
4646
en:
4747
localisedName: Medusa
48-
genericName: Text Editor
4948
shortDescription: >
5049
This description can have a maximum 150
5150
characters long. We should not fill the

docs/standard/schema.core.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -368,11 +368,11 @@ name most people usually refer to the software. In case the software has
368368
both an internal “code” name and a commercial name, use the commercial
369369
name.
370370

371-
Key ``description/[lang]/genericName``
372-
''''''''''''''''''''''''''''''''''''''
371+
Key ``description/[lang]/genericName`` (*deprecated*)
372+
'''''''''''''''''''''''''''''''''''''''''''''''''''''
373373

374374
- Type: string (max 35 chars)
375-
- Presence: mandatory
375+
- Presence: optional
376376
- Example: ``"Text Editor"``
377377

378378
This key is the “Generic name”, which refers to the specific category to

0 commit comments

Comments
 (0)