minor updates to docs (#99)

- fix typo in permissions.rst code snippets
- declare minimum version for new `--jobs `arg
- resolve undefined reference to `HTTPError`

Author: 2bndy5

cpp_linter/cli.py

@@ -325,8 +325,8 @@ def _parse_jobs(val: str) -> Optional[int]:
     default=1,
     type=_parse_jobs,
     help="""Set the number of jobs to run simultaneously.
-If set to <= 0, the number of jobs will be set to the
-number of all available CPU cores.
+If set less than or equal to 0, the number of jobs will
+be set to the number of all available CPU cores.
 
 Defaults to ``%(default)s``.""",
 )

cpp_linter/rest_api/__init__.py

@@ -35,8 +35,9 @@ def api_request(
         :param data: The HTTP request payload data.
         :param headers: The HTTP request headers to use. This can be used to override
             the default headers used.
-        :param strict: If this is set `True`, then an `HTTPError` will be raised when
-            the HTTP request responds with a status code greater than or equal to 400.
+        :param strict: If this is set `True`, then an :py:class:`~requests.HTTPError`
+            will be raised when the HTTP request responds with a status code greater
+            than or equal to 400.
 
         :returns:
             The HTTP request's response object.

docs/conf.py

@@ -181,7 +181,7 @@ def run(self):
 class CliBadgeVersion(CliBadge):
     badge_type = "version"
     href = "https://github.com/cpp-linter/cpp-linter/releases/v"
-    href_title = "Required Version"
+    href_title = "Minimum Version"
 
     def run(self):
         self.badge_icon = load_svg_into_builder_env(
@@ -211,12 +211,13 @@ def run(self):
     "1.6.1": ["thread_comments", "no_lgtm"],
     "1.6.0": ["step_summary"],
     "1.4.7": ["extra_arg"],
+    "1.8.1": ["jobs"],
 }
 
 PERMISSIONS = {
     "thread_comments": ["thread-comments", "issues: write"],
-    "tidy_review": ["pull-request-reviews", "pull_request: write"],
-    "format_review": ["pull-request-reviews", "pull_request: write"],
+    "tidy_review": ["pull-request-reviews", "pull-requests: write"],
+    "format_review": ["pull-request-reviews", "pull-requests: write"],
     "files_changed_only": ["file-changes", "contents: read"],
     "lines_changed_only": ["file-changes", "contents: read"],
 }

docs/permissions.rst

@@ -31,7 +31,7 @@ The :std:option:`--thread-comments` feature requires the following permissions:
 
     permissions:
       issues: write # (1)!
-      pull_requests: write # (2)!
+      pull-requests: write # (2)!
 
 .. code-annotations::
 
@@ -47,4 +47,4 @@ The :std:option:`--tidy-review` and :std:option:`--format-review` features requi
 .. code-block:: yaml
 
     permissions:
-      pull_requests: write
+      pull-requests: write