From 6187ce4a05346b2eec87914763e83a82d856f027 Mon Sep 17 00:00:00 2001 From: mprahl Date: May 06 2019 15:13:23 +0000 Subject: Update the SCM.__init__ docstring --- diff --git a/module_build_service/scm.py b/module_build_service/scm.py index a0513cf..8124e35 100644 --- a/module_build_service/scm.py +++ b/module_build_service/scm.py @@ -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 """