Allow author, top-level description, and todo to be a string instead …

…of a list of strings.
ansible-community · Dec 14, 2023 · 2458b55 · 2458b55
1 parent 8305647
commit 2458b55
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/changelogs/fragments/227-role-argspec-str-to-list.yml b/changelogs/fragments/227-role-argspec-str-to-list.yml
@@ -0,0 +1,2 @@
+bugfixes:
+  - "For role argument specs, allow ``author``, ``description``, and ``todo`` to be a string instead of a list of strings, similarly as with ansible-doc and with modules and plugins (https://github.com/ansible-community/antsibull-docs/pull/227)."
diff --git a/src/antsibull_docs/schemas/docs/role.py b/src/antsibull_docs/schemas/docs/role.py
@@ -26,6 +26,7 @@
     SeeAlsoLinkSchema,
     SeeAlsoModSchema,
     SeeAlsoRefSchema,
+    list_from_scalars,
 )
 
 _SENTINEL = object()
@@ -69,6 +70,16 @@ class RoleEntrypointSchema(BaseModel):
 
     options: dict[str, RoleOptionsSchema] = {}
 
+    @p.validator(
+        "author",
+        "description",
+        "todo",
+        pre=True,
+    )
+    # pylint:disable=no-self-argument
+    def list_from_scalars(cls, obj):
+        return list_from_scalars(obj)
+
 
 class RoleSchema(BaseModel):
     """Documentation for roles."""
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		bugfixes:
		- "For role argument specs, allow ``author``, ``description``, and ``todo`` to be a string instead of a list of strings, similarly as with ansible-doc and with modules and plugins (https://github.com/ansible-community/antsibull-docs/pull/227)."