modules/fm-orchestrator
1
0
Fork 0
mirror of https://pagure.io/fm-orchestrator.git synced 2026-04-05 19:57:37 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update the SCM.__init__ docstring

Browse Source
This commit is contained in:
mprahl
2019-04-29 14:18:49 -04:00
parent b75c3dd76e
commit 6187ce4a05
1 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
module_build_service/scm.py
View File

@@ -51,12 +51,16 @@ class SCM(object):
types = scm_url_schemes()
def __init__(self, url, branch=None, allowed_scm=None, allow_local=False):
"""Initialize the SCM object using the specified scmurl.
"""
Initialize the SCM object using the specified SCM URL.
If url is not in the list of allowed_scm, an error will be raised.
:param str url: The unmodified scmurl
:param list allowed_scm: The list of allowed SCMs, optional
:param str branch: The optional source control branch. This defaults to "master" when git
is used.
:param list allowed_scm: The optional list of allowed SCM URL prefixes
:param bool allow_local: Allow SCM URLs that start with "file://"
:raises: Forbidden or ValidationError
"""