Clarify documentation for check actions

westphahl · westphahl · commit d5c7f5b956b9 · 2019-01-11T15:23:42.000+01:00
diff --git a/src/github3/checks.py b/src/github3/checks.py
@@ -499,11 +499,12 @@ def update(
             format: YYYY-MM-DDTHH:MM:SSZ
         :param dict output:
             (optional), key-value pairs representing the output. Format:
-            {'title': 'string', 'summary', 'text, can be markdown', 'text':
-            'text, can be markdown', 'annotations': [{}], 'images': [{}]}
-        :param array actions:
-            (optional), array of action objects. Object format is:
-            {'label': 'text', 'description', 'text', 'identifier', 'text'}
+            ``{'title': 'string', 'summary', 'text, can be markdown', 'text':
+            'text, can be markdown', 'annotations': [{}], 'images': [{}]}``
+        :param list actions:
+            (optional), list of action objects. Format is:
+            ``[{'label': 'text', 'description', 'text', 'identifier', 'text'},
+            ...]``
         :returns:
             True if successful, False otherwise
         :rtype:
diff --git a/src/github3/repos/repo.py b/src/github3/repos/repo.py
@@ -598,11 +598,12 @@ def create_check_run(
             format: YYYY-MM-DDTHH:MM:SSZ
         :param dict output:
             (optional), key-value pairs representing the output. Format:
-            {'title': 'string', 'summary': 'text, can be markdown', 'text':
-            'text, can be markdown', 'annotations': [{}], 'images': [{}]}
-        :param array actions:
-            (optional), array of action objects. Object format is:
-            {'label': 'text', 'description', 'text', 'identifier', 'text'}
+            ``{'title': 'string', 'summary': 'text, can be markdown', 'text':
+            'text, can be markdown', 'annotations': [{}], 'images': [{}]}``
+        :param list actions:
+            (optional), list of action objects. Format is:
+            ``[{'label': 'text', 'description', 'text', 'identifier', 'text'},
+            ...]``
         :returns:
             the created check run
         :rtype:
