Merge pull request #146 from bfabio/proposal/generic-name

docs(standard): make genericName optional and deprecate it
publiccodeyml · May 2, 2022 · 68be412 · 68be412
2 parents f688eb9 + 1edbf77
commit 68be412
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 5 deletions.
diff --git a/docs/standard/example/publiccode.minimal.yml b/docs/standard/example/publiccode.minimal.yml
@@ -17,7 +17,6 @@ softwareType: "standalone/desktop"
 description:
   en:
     localisedName: medusa   # Optional
-    genericName: Text Editor
     shortDescription: >
           A rather short description which
           is probably useless

diff --git a/docs/standard/example/publiccode.yml b/docs/standard/example/publiccode.yml
@@ -40,7 +40,6 @@ intendedAudience:
 description:
   en:
     localisedName: Medusa
-    genericName: Text Editor
     shortDescription: >
           This description can have a maximum 150
           characters long. We should not fill the

diff --git a/docs/standard/schema.core.rst b/docs/standard/schema.core.rst
@@ -368,11 +368,11 @@ name most people usually refer to the software. In case the software has
 both an internal “code” name and a commercial name, use the commercial
 name.
 
-Key ``description/[lang]/genericName``
-''''''''''''''''''''''''''''''''''''''
+Key ``description/[lang]/genericName`` (*deprecated*)
+'''''''''''''''''''''''''''''''''''''''''''''''''''''
 
 -  Type: string (max 35 chars)
--  Presence: mandatory
+-  Presence: optional
 -  Example: ``"Text Editor"``
 
 This key is the “Generic name”, which refers to the specific category to