Skip to content

Commit

Permalink
Add new function docstring
Browse files Browse the repository at this point in the history
Signed-off-by: romanodanilo <[email protected]>
  • Loading branch information
romanodanilo committed Jul 10, 2024
1 parent 277b3d3 commit cbeca41
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions qc_openscenario/checks/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,15 +45,15 @@ def compare_versions(version1: str, version2: str) -> int:

def get_parameter_value(
root: etree._ElementTree, parameter_name: str
) -> Union[None, str]:
"""_summary_
) -> Union[None, str, int, float]:
"""Read all ParameterDeclaration nodes from root and get the value of parameter_name if present
Args:
root (etree._ElementTree): _description_
parameter (str): _description_
root (etree._ElementTree): root node of the xml document
parameter_name (str): the parameter name to search
Returns:
Union[None, str]: _description_
Union[None, str, int, float]: the parameter value is present, with its type. None if the parameter_name is not found
"""
param_declarations = root.findall(".//ParameterDeclaration")
if param_declarations is None:
Expand Down

0 comments on commit cbeca41

Please sign in to comment.