Skip to content

Commit e370f75

Browse files
committed
Fix docstrings
1 parent c994bfb commit e370f75

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

sonar/projects.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1450,7 +1450,7 @@ def audit(endpoint: pf.Platform, audit_settings: types.ConfigSettings, **kwargs)
14501450
14511451
:param Platform endpoint: reference to the SonarQube platform
14521452
:param ConfigSettings audit_settings: Configuration of audit
1453-
:returns: list of problems found
1453+
:return: list of problems found
14541454
"""
14551455
if not audit_settings.get("audit.projects", True):
14561456
log.info("Auditing projects is disabled, audit skipped...")
@@ -1489,7 +1489,7 @@ def export(endpoint: pf.Platform, export_settings: types.ConfigSettings, **kwarg
14891489
14901490
:param Platform endpoint: reference to the SonarQube platform
14911491
:param ConfigSettings export_settings: Export parameters
1492-
:returns: list of projects settings
1492+
:return: list of projects settings
14931493
"""
14941494

14951495
write_q = kwargs.get("write_q", None)
@@ -1520,12 +1520,12 @@ def export(endpoint: pf.Platform, export_settings: types.ConfigSettings, **kwarg
15201520
return dict(sorted(results.items()))
15211521

15221522

1523-
def exists(key: str, endpoint: pf.Platform) -> bool:
1524-
"""
1525-
:param str key: project key to check
1523+
def exists(endpoint: pf.Platform, key: str) -> bool:
1524+
"""Returns whether a project exists
1525+
15261526
:param Platform endpoint: reference to the SonarQube platform
1527-
:returns: whether the project exists
1528-
:rtype: bool
1527+
:param str key: project key to check
1528+
:return: whether the project exists
15291529
"""
15301530
try:
15311531
Project.get_object(endpoint, key)

0 commit comments

Comments
 (0)