ED/EDMarketConnector
1
0
Fork 0
mirror of https://github.com/EDCD/EDMarketConnector.git synced 2025-04-17 17:42:20 +03:00
Code Issues Projects Releases Wiki Activity

clarified docstrings

Browse Source
This commit is contained in:
A_D 2021-08-19 20:46:02 +02:00
parent 3e5efb03ec
commit 8134a04739
No known key found for this signature in database
GPG Key ID: 4BE9EB7DF45076C4
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
killswitch.py
View File

@ -217,7 +217,6 @@ class KillSwitchSet:
current EDMC version current EDMC version
:return: a namedtuple indicating status and reason, if any :return: a namedtuple indicating status and reason, if any
""" """
if isinstance(version, str): if isinstance(version, str):
version = semantic_version.Version.coerce(version) version = semantic_version.Version.coerce(version)
@ -254,7 +253,7 @@ class KillSwitchSet:
:param name: The killswitch to check :param name: The killswitch to check
:param data: The data to modify if needed :param data: The data to modify if needed
:return: A bool indicating if the caller should return, and either the :return: A two tuple consisting of: A bool indicating if the caller should return, and either the
original data or a *COPY* that has been modified by rules original data or a *COPY* that has been modified by rules
""" """
res = self.get_disabled(name, version=version) res = self.get_disabled(name, version=version)
@ -288,7 +287,7 @@ class KillSwitchSet:
:param data: the data to update :param data: the data to update
:param log: the logger to use, defaults to the standard EDMC main logger :param log: the logger to use, defaults to the standard EDMC main logger
:return: A tuple of bool and updated data, where the bool is true when the caller _should_ halt processing :return: A two tuple of bool and updated data, where the bool is true when the caller _should_ halt processing
""" """
for name in names: for name in names:
should_return, data = self.check_killswitch(name=name, data=data, log=log, version=version) should_return, data = self.check_killswitch(name=name, data=data, log=log, version=version)