From e4f34ee8151facb7cc7b6954a0ad7c8764134c8f Mon Sep 17 00:00:00 2001 From: Eduardo Gonzalez Date: Tue, 17 Apr 2018 09:38:56 +0200 Subject: [PATCH] Fix docstrings params Some docstring params doens't match with the param expected from the function. Also fixes some param ordering to match the order the function expects them. Change-Id: Ia2b4d71ab46cc326f0a1bcbd83d2bf58937bfed4 --- jenkins/__init__.py | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/jenkins/__init__.py b/jenkins/__init__.py index baa209a..014dc7b 100755 --- a/jenkins/__init__.py +++ b/jenkins/__init__.py @@ -286,9 +286,9 @@ class Jenkins(object): All methods will raise :class:`JenkinsException` on failure. + :param url: URL of Jenkins server, ``str`` :param username: Server username, ``str`` :param password: Server password, ``str`` - :param url: URL of Jenkins server, ``str`` :param timeout: Server connection timeout in secs (default: not set), ``int`` ''' if url[-1] == '/': @@ -564,7 +564,7 @@ class Jenkins(object): '''Get build information dictionary. :param name: Job name, ``str`` - :param name: Build number, ``int`` + :param number: Build number, ``int`` :param depth: JSON depth, ``int`` :returns: dictionary of build information, ``dict`` @@ -1132,8 +1132,9 @@ class Jenkins(object): Use ``list of two membered tuples`` to supply parameters with multi select options. + :param name: Name of Jenkins job, ``str`` :param parameters: parameters for job, or None., ``dict`` or - ``list of two membered tuples`` + ``list of two membered tuples`` :param token: (optional) token for building job, ``str`` :returns: URL for building job ''' @@ -1661,8 +1662,8 @@ class Jenkins(object): quickly verify a promotion exists for a job or is accessible without causing too much stress on the server side. - :param job_name: Job name, ``str`` :param name: Promotion name, ``str`` + :param job_name: Job name, ``str`` :returns: Name of promotion or None ''' folder_url, short_name = self._get_job_folder(job_name) @@ -1684,8 +1685,8 @@ class Jenkins(object): 'exist for job[%s]'): '''Raise an exception if a job lacks a promotion - :param job_name: Job name, ``str`` :param name: Name of Jenkins promotion, ``str`` + :param job_name: Job name, ``str`` :param exception_message: Message to use for the exception. Formatted with ``name`` and ``job_name`` :throws: :class:`JenkinsException` whenever the promotion @@ -1697,8 +1698,8 @@ class Jenkins(object): def promotion_exists(self, name, job_name): '''Check whether a job has a certain promotion - :param job_name: Job name, ``str`` :param name: Name of Jenkins promotion, ``str`` + :param job_name: Job name, ``str`` :returns: ``True`` if Jenkins promotion exists ''' return self.get_promotion_name(name, job_name) == name @@ -1706,7 +1707,7 @@ class Jenkins(object): def get_promotions_info(self, job_name, depth=0): '''Get promotion information dictionary of a job - :param name: job_name, ``str`` + :param job_name: job_name, ``str`` :param depth: JSON depth, ``int`` :returns: Dictionary of promotion info, ``dict`` ''' @@ -1737,8 +1738,8 @@ class Jenkins(object): def delete_promotion(self, name, job_name): '''Delete Jenkins promotion permanently. - :param job_name: Job name, ``str`` :param name: Name of Jenkins promotion, ``str`` + :param job_name: Job name, ``str`` ''' folder_url, short_name = self._get_job_folder(job_name) self.jenkins_open(requests.Request(