Static analyzer: misspelling words

.github/workflows/test.yml

@@ -18,7 +18,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [ '3.6', '3.7', '3.8', '3.9' ]
+        python-version: [ '3.6', '3.7', '3.8', '3.9', '3.11' ]
 
     steps:
       - uses: actions/checkout@v3

atlassian/bamboo.py

@@ -509,7 +509,7 @@ def build_result(
         Returns details of a specific build result
         :param expand: expands build result details on request. Possible values are: artifacts, comments, labels,
         Jira Issues, stages. stages expand is available only for top level plans. It allows to drill down to job results
-        using stages.stage.results.result. All expand parameters should contain results.result prefix.
+        using stages.stage.results.result. All expand parameters should contain results. Result prefix.
         :param build_key: Should be in the form XX-YY[-ZZ]-99, that is, the last token should be an integer representing
         the build number
         :param include_all_states
@@ -536,7 +536,7 @@ def build_latest_result(self, plan_key, expand=None, include_all_states=False):
         Returns details of a latest build result
         :param expand: expands build result details on request. Possible values are: artifacts, comments, labels,
         Jira Issues, stages. stages expand is available only for top level plans. It allows to drill down to job results
-        using stages.stage.results.result. All expand parameters should contain results.result prefix.
+        using stages.stage.results.result. All expand parameters should contain results. Result prefix.
         :param plan_key: Should be in the form XX-YY[-ZZ]
         :param include_all_states:
         """

atlassian/bitbucket/__init__.py

@@ -695,10 +695,10 @@ def update_project_condition(self, project_key, condition, id_condition):
 
     def delete_project_condition(self, project_key, id_condition):
         """
-        Request type: DELETE
         Delete a specific condition for this repository slug inside project.
         For further information visit:
             https://docs.atlassian.com/bitbucket-server/rest/5.16.0/bitbucket-default-reviewers-rest.html#idm52264896304
+        Request type: DELETE
         :projectKey: str- project key involved
         :idCondition: int - condition id involved
         :return:
@@ -958,7 +958,7 @@ def repo_grant_user_permissions(self, project_key, repo_key, username, permissio
         Grant the specified repository permission to a specific user
         :param project_key: The project key
         :param repo_key: The repository key (slug)
-        :param username: user name to be granted
+        :param username: username to be granted
         :param permission: the repository permissions available are 'REPO_ADMIN', 'REPO_WRITE' and 'REPO_READ'
         :return:
         """
@@ -975,7 +975,7 @@ def repo_remove_user_permissions(self, project_key, repo_key, username):
         if they do not have a higher project or global permission.
         :param project_key: The project key
         :param repo_key: The repository key (slug)
-        :param username: user name to be granted
+        :param username: username to be granted
         :return:
         """
         url = self._url_repo_users(project_key, repo_key)
@@ -1567,7 +1567,7 @@ def get_pull_requests(
         :param project_key:
         :param repository_slug:
         :param state:
-        :param order: OPTIONAL: defaults to NEWEST) the order to return pull requests in, either OLDEST
+        :param order: OPTIONAL: defaults to NEWEST the order to return pull requests in, either OLDEST
                                 (as in: "oldest first") or NEWEST.
         :param limit:
         :param start:
@@ -1915,7 +1915,7 @@ def update_pull_request_comment(
         Update the text of a comment.
         Only the user who created a comment may update it.
 
-        Note: the supplied supplied JSON object must contain a version
+        Note: the supplied JSON object must contain a version
         that must match the server's version of the comment
         or the update will fail.
         """
@@ -2410,7 +2410,7 @@ def get_file_list(
     ):
         """
         Retrieve a page of files from particular directory of a repository.
-        The search is done recursively, so all files from any sub-directory of the specified directory will be returned.
+        The search is done recursively, so all files from any subdirectory of the specified directory will be returned.
         The authenticated user must have REPO_READ permission for the specified repository to call this resource.
         :param start:
         :param project_key:
@@ -2880,10 +2880,10 @@ def update_repo_condition(self, project_key, repo_key, condition, id_condition):
 
     def delete_repo_condition(self, project_key, repo_key, id_condition):
         """
-        Request type: DELETE
         Delete a specific condition for this repository slug inside project.
         For further information visit:
             https://docs.atlassian.com/bitbucket-server/rest/5.16.0/bitbucket-default-reviewers-rest.html#idm8287339888
+        Request type: DELETE
         :projectKey: str- project key involved
         :repoKey: str - repo key involved
         :idCondition: int - condition id involved

atlassian/bitbucket/cloud/common/builds.py

@@ -62,8 +62,8 @@ def commit(self):
 
     @property
     def website(self):
-        """Return the url to the builds webpage.
-
+        """
+        Return the url to the build's webpage.
         This url points to the build's frontend website (Pipelines, Jenkins ...)
         """
         return self.get_data("url")

atlassian/bitbucket/cloud/repositories/__init__.py

@@ -127,7 +127,7 @@ def each(self, role=None, q=None, sort=None):
         """
         Get all repositories in the workspace matching the criteria.
 
-        :param role: string: Filters the workspaces based on the authenticated user"s role on each workspace.
+        :param role: string: Filters the workspaces based on the authenticated user's role on each workspace.
                              * member: returns a list of all the workspaces which the caller is a member of
                                at least one workspace group or repository
                              * collaborator: returns a list of workspaces which the caller has write access

atlassian/bitbucket/cloud/repositories/commits.py

@@ -92,8 +92,7 @@ def parents(self):
 
     def statuses(self):
         """
-        Return generator object of the statuses endpoint.
-
+        Return generator object of the status's endpoint.
         API docs: https://developer.atlassian.com/cloud/bitbucket/rest/api-group-commit-statuses/#api-repositories-workspace-repo-slug-commit-commit-statuses-get
         """
         return self._get_paged("statuses")
@@ -146,7 +145,6 @@ def get_build(self, key):
     def comments(self):
         """
         Return generator object of the comments endpoint.
-
         API docs: https://developer.atlassian.com/cloud/bitbucket/rest/api-group-commits/#api-repositories-workspace-repo-slug-commit-commit-comments-get
         """
         for comment in self._get_paged("comments"):

atlassian/bitbucket/cloud/repositories/defaultReviewers.py

@@ -61,7 +61,7 @@ def get(self, user):
         """
         Returns the default reviewer in this repository.
 
-        :param user: string: The requested user name
+        :param user: string: The requested username
 
         :return: The requested DefaultReviewer object, None if not a default reviewer
 

atlassian/bitbucket/cloud/repositories/pipelines.py

@@ -27,7 +27,7 @@ def trigger(self, branch="master", commit=None, pattern=None, variables=None):
         2. Specific commit on a branch (additionally specify ``commit``)
         3. Specific pipeline (additionally specify ``pattern``. ``commit`` is optional here)
 
-        Variables has to be a list of dictionaries:
+        Variables have to be a list of dictionaries:
 
         {
            "key": "var1key",

atlassian/bitbucket/server/common/permissions.py

@@ -24,7 +24,7 @@ def admin(self, name):
 
     def write(self, name):
         """
-        Add the write permission for a group/user.
+        Add to write permission for a group/user.
         """
         return self.add(name, self.__permission(self.WRITE))
 
@@ -54,7 +54,7 @@ def each(self, filter=None):
         """
         Get all groups/users.
 
-        :params filter: string: If specified only group/user names containing the supplied string will be returned
+        :params filter: string: If specified only group/usernames containing the supplied string will be returned
 
         :return: A generator for the group/user permission objects
 
@@ -76,7 +76,7 @@ def each_none(self, filter=None):
         """
         Get all not granted groups/users.
 
-        :params filter: string: If specified only group/user names containing the supplied string will be returned
+        :params filter: string: If specified only group/usernames containing the supplied string will be returned
 
         :return: A generator for the group/user permission objects
 

atlassian/bitbucket/server/globalPermissions.py

@@ -32,7 +32,7 @@ def admin(self, name):
 
     def sys_admin(self, name):
         """
-        Add the sys admin permission for a group/user.
+        Add the sysadmin permission for a group/user.
         """
         return self.add(name, self.__permission(self.SYS_ADMIN))
 
@@ -54,7 +54,7 @@ def each(self, filter=None):
         """
         Get all groups/users.
 
-        :params filter: string: If specified only group/user names containing the supplied string will be returned
+        :params filter: string: If specified only group/usernames containing the supplied string will be returned
 
         :return: A generator for the group/user permission objects
 
@@ -74,7 +74,7 @@ def each_none(self, filter=None):
         """
         Get all not granted groups/users.
 
-        :params filter: string: If specified only group/user names containing the supplied string will be returned
+        :params filter: string: If specified only group/usernames containing the supplied string will be returned
 
         :return: A generator for the group/user permission objects
 

atlassian/confluence.py

@@ -328,7 +328,7 @@ def get_page_by_id(self, page_id, expand=None, status=None, version=None):
         :param version: (int)
         :param expand: OPTIONAL: Default value: history,space,version
                        We can also specify some extensions such as extensions.inlineProperties
-                       (for getting inline comment-specific properties) or extensions.resolution
+                       (for getting inline comment-specific properties) or extensions. Resolution
                        for the resolution status of each comment in the results
         :return:
         """
@@ -916,7 +916,7 @@ def get_content_template(self, template_id):
     @deprecated(version="3.7.0", reason="Use get_blueprint_templates()")
     def get_all_blueprints_from_space(self, space, start=0, limit=None, expand=None):
         """
-        Get all users blue prints from space. Experimental API
+        Get all users blueprints from space. Experimental API
         :param space: Space Key
         :param start: OPTIONAL: The start point of the collection to return. Default: None (0).
         :param limit: OPTIONAL: The limit of the number of pages to return, this may be restricted by
@@ -2286,7 +2286,7 @@ def get_space_property(self, space_key, expand=None):
     def get_user_details_by_username(self, username, expand=None):
         """
         Get information about a user through username
-        :param username: The user name
+        :param username: The username
         :param expand: OPTIONAL expand for get status of user.
                 Possible param is "status". Results are "Active, Deactivated"
         :return: Returns the user details
@@ -2537,7 +2537,7 @@ def check_access_mode(self):
 
     def anonymous(self):
         """
-        Get information about the how anonymous is represented in confluence
+        Get information about how anonymous is represented in confluence
         :return:
         """
         try:
@@ -2667,9 +2667,9 @@ def check_long_task_result(self, task_id, expand=None):
     def get_pdf_download_url_for_confluence_cloud(self, url):
         """
         Confluence cloud does not return the PDF document when the PDF
-        export is initiated. Instead it starts a process in the background
+        export is initiated. Instead, it starts a process in the background
         and provides a link to download the PDF once the process completes.
-        This functions polls the long running task page and returns the
+        This functions polls the long-running task page and returns the
         download url of the PDF.
         :param url: URL to initiate PDF export
         :return: Download url for PDF file
@@ -2895,7 +2895,7 @@ def get_space_permissions(self, space_key):
 
     def get_subtree_of_content_ids(self, page_id):
         """
-        Get sub tree of page ids
+        Get subtree of page ids
         :param page_id:
         :return: Set of page ID
         """

atlassian/insight.py

@@ -42,7 +42,7 @@ def __cloud_init(self, *args, **kwargs):
         kwargs["url"] = "https://api.atlassian.com"
         # set cloud back to true and return
         kwargs["cloud"] = True
-        # Insight cloud is particular about its headers..
+        # Insight cloud is particular about its headers.
         self.default_headers = {"Accept": "application/json"}
         return args, kwargs
 
@@ -627,7 +627,7 @@ def update_issue_insight_field(self, key, field_id, insight_keys, add=False):
         Set the value of an Insight field.
         Args:
             key (str): Jira issue key, eg. SFT-446
-            field_id (str): The internal Jira name of the Insight field, eg. customfield_10200
+            field_id (str): The internal Jira name of the Insight field, e.g. customfield_10200
             insight_keys (list): List of Insight objects to associate with the field. Limited
                 to 20 objects. If the field only takes a single object pass a single value list.
             add (bool, optional): Add to the existing field rather than setting the field value.