Polish docs and add tests into package

Author: gonchik

.github/bump_version

@@ -2,7 +2,7 @@
 
 if [[ ( -z ${1+x} ) || ( -z ${2+x} ) ]]; then
     cat << EOF
-        usage: $(basename ${0}) repo increment
+        usage: $(basename "${0}") repo increment
 
         Quick and dirty version bump script
         If a variable "BUILD_VERSION" is set, returns that variable as is
@@ -30,7 +30,7 @@ function autoversion(){
         BUILD_NUMBER="0"  # In the developer machine, this will build x.y.z.dev0
     fi
 
-    cd ${REPO_PATH} || exit 1
+    cd "${REPO_PATH}" || exit 1
 
     git fetch --tags 2>/dev/null
     last_tag=$(git tag | sort -Vr | head -1)

atlassian/VERSION

@@ -1 +1 @@
-3.40.0
+3.40.1

atlassian/bamboo.py

@@ -127,8 +127,8 @@ def project(self, project_key, expand=None, favourite=False, clover_enabled=Fals
 
     def project_plans(self, project_key, start_index=0, max_results=25):
         """
-        Returns a generator with the plans in a given project
-        :param project_key: Project key
+        Returns a generator with the plans in a given project.
+        :param project_key: project key
         :param start_index:
         :param max_results:
         :return: Generator with plans
@@ -295,7 +295,7 @@ def create_branch(
         :param branch_name: str new-shiny-branch
         :param vcs_branch: str feature/new-shiny-branch, /refs/heads/new-shiny-branch
         :param enabled: bool
-        :param cleanup_enabled: bool
+        :param cleanup_enabled: bool - enable/disable automatic cleanup of branch
         :return: PUT request
         """
         resource = "plan/{plan_key}/branch/{branch_name}".format(plan_key=plan_key, branch_name=branch_name)
@@ -398,7 +398,7 @@ def latest_results(
         include_all_states=False,
     ):
         """
-        Get latest Results
+        Get the latest Results
         :param expand:
         :param favourite:
         :param clover_enabled:
@@ -433,7 +433,7 @@ def project_latest_results(
         include_all_states=False,
     ):
         """
-        Get latest Project Results
+        Get the latest Project Results
         :param project_key:
         :param expand:
         :param favourite:
@@ -533,7 +533,7 @@ def build_result(
 
     def build_latest_result(self, plan_key, expand=None, include_all_states=False):
         """
-        Returns details of a latest build result
+        Returns details of the 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.

atlassian/bitbucket/base.py

@@ -50,7 +50,7 @@ def _get_paged(
         Used to get the paged data
 
         :param url: string:                        The url to retrieve
-        :param params: dict (default is None):     The parameters
+        :param params: dict (default is None):     The parameter's
         :param data: dict (default is None):       The data
         :param flags: string[] (default is None):  The flags
         :param trailing: bool (default is None):   If True, a trailing slash is added to the url

atlassian/bitbucket/cloud/base.py

@@ -51,7 +51,7 @@ def _get_paged(
         Used to get the paged data
 
         :param url: string:                        The url to retrieve
-        :param params: dict (default is None):     The parameters
+        :param params: dict (default is None):     The parameter's
         :param data: dict (default is None):       The data
         :param flags: string[] (default is None):  The flags
         :param trailing: bool (default is None):   If True, a trailing slash is added to the url

atlassian/bitbucket/cloud/repositories/commits.py

@@ -144,7 +144,7 @@ def get_build(self, key):
 
     def comments(self):
         """
-        Return generator object of the comments endpoint.
+        Return generator object endpoint of the comment.
         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

@@ -19,7 +19,7 @@ def __get_object(self, data):
 
     def add(self, user):
         """
-        Adds the specified user to the repository"s list of default reviewers.
+        Adds the specified user to the repository's list of default reviewers.
 
         This method is idempotent. Adding a user a second time has no effect.
 
@@ -34,7 +34,7 @@ def add(self, user):
 
     def each(self, q=None, sort=None):
         """
-        Returns the repository"s default reviewers.
+        Returns the repository's default reviewers.
         These are the users that are automatically added as reviewers on every new pull request
         that is created.
 

atlassian/bitbucket/server/base.py

@@ -30,7 +30,7 @@ def _get_paged(
         Used to get the paged data
 
         :param url: string:                        The url to retrieve
-        :param params: dict (default is None):     The parameters
+        :param params: dict (default is None):     The parameter's
         :param data: dict (default is None):       The data
         :param flags: string[] (default is None):  The flags
         :param trailing: bool (default is None):   If True, a trailing slash is added to the url

atlassian/confluence.py

@@ -59,7 +59,7 @@ def _get_paged(
         Used to get the paged data
 
         :param url: string:                        The url to retrieve
-        :param params: dict (default is None):     The parameters
+        :param params: dict (default is None):     The parameter's
         :param data: dict (default is None):       The data
         :param flags: string[] (default is None):  The flags
         :param trailing: bool (default is None):   If True, a trailing slash is added to the url
@@ -210,7 +210,7 @@ def get_child_pages(self, page_id):
 
     def get_page_id(self, space, title, type="page"):
         """
-        Provide content id from search result by title and space
+        Provide content id from search result by title and space.
         :param space: SPACE key
         :param title: title
         :param type: type of content: Page or Blogpost. Defaults to page
@@ -250,7 +250,7 @@ def get_parent_content_title(self, page_id):
 
     def get_page_space(self, page_id):
         """
-        Provide space key from content id
+        Provide space key from content id.
         :param page_id: content ID
         :return:
         """
@@ -1138,8 +1138,8 @@ def attach_content(
         comment=None,
     ):
         """
-        Attach (upload) a file to a page, if it exists it will update the
-        automatically version the new file and keep the old one.
+        Attach (upload) a file to a page, if it exists it will update automatically the
+        version the new file and keep the old one.
         :param title: The page name
         :type  title: ``str``
         :param space: The space name
@@ -1218,8 +1218,8 @@ def attach_file(
         comment=None,
     ):
         """
-        Attach (upload) a file to a page, if it exists it will update the
-        automatically version the new file and keep the old one.
+        Attach (upload) a file to a page, if it exists it will update automatically the
+        version the new file and keep the old one.
         :param title: The page name
         :type  title: ``str``
         :param space: The space name
@@ -2899,8 +2899,8 @@ def add_user_to_group(self, username, group_name):
         """
         Add given user to a group
 
-        :param username: str
-        :param group_name: str
+        :param username: str - username of user to add to group
+        :param group_name: str - name of group to add user to
         :return: Current state of the group
         """
         url = "rest/api/2/group/user"
@@ -2919,11 +2919,11 @@ def add_space_permissions(
         """
         Add permissions to a space
 
-        :param space_key: str
-        :param subject_type: str
-        :param subject_id: str
-        :param operation_key: str
-        :param operation_target: str
+        :param space_key: str - key of space to add permissions to
+        :param subject_type: str - type of subject to add permissions for
+        :param subject_id: str - id of subject to add permissions for
+        :param operation_key: str - key of operation to add permissions for
+        :param operation_target: str - target of operation to add permissions for
         :return: Current permissions of space
         """
         url = "rest/api/space/{}/permission".format(space_key)

atlassian/crowd.py

@@ -32,10 +32,9 @@ def _crowd_api_url(self, api, resource):
 
     def _user_change_status(self, username, active):
         """
-        Change user status
-
-        :params active bool
-
+        Change user status.
+        :param username: str - username
+        :param active: bool - True/False
         :return:
         """
 
@@ -59,12 +58,18 @@ def _user_change_status(self, username, active):
         )
 
     def user(self, username):
+        """
+        Get user information
+        :param username:
+        :return:
+        """
         params = {"username": username}
         return self.get(self._crowd_api_url("usermanagement", "user"), params=params)
 
     def user_activate(self, username):
         """
         Activate user
+        :param username: str - username
         """
 
         return self._user_change_status(username, True)
@@ -116,7 +121,7 @@ def user_deactivate(self, username):
     def user_delete(self, username):
         """
         Delete user
-
+        :param username: str - username
         :return:
         """
 
@@ -141,6 +146,11 @@ def group_add_user(self, username, groupname):
         )
 
     def group_nested_members(self, group):
+        """
+        Get nested members of group
+        :param group:
+        :return:
+        """
         params = {"groupname": group}
         return self.get(self._crowd_api_url("group", "nested"), params=params)