From 0ba7c13b90230182038868bd48766ce022760cce Mon Sep 17 00:00:00 2001
From: Viktor Vorobev <vorobev@in.tum.de>
Date: Thu, 15 Apr 2021 12:15:34 +0000
Subject: [PATCH] Merged in NRRPLT-8242-fix-docstrings (pull request #31)
[NRRPLT-8242] Fix docstrings
look for missing empty line
^( +)\w.*$\n\1:
look for missing descr indent
^( +)(:.*)$\n\1\w
look for missing :
^ +:\w+ [^:]+$
Approved-by: Ugo Albanese
Approved-by: Eloy Retamino
---
hbp_nrp_virtual_coach/pynrp/config.py | 6 +++---
hbp_nrp_virtual_coach/pynrp/simulation.py | 3 ++-
2 files changed, 5 insertions(+), 4 deletions(-)
diff --git a/hbp_nrp_virtual_coach/pynrp/config.py b/hbp_nrp_virtual_coach/pynrp/config.py
index 97dc6ae..0beab11 100644
--- a/hbp_nrp_virtual_coach/pynrp/config.py
+++ b/hbp_nrp_virtual_coach/pynrp/config.py
@@ -49,7 +49,7 @@ class Config(dict):
Load and validate the configuration file. Update all proxy service parameters to use
the given environment.
- :param environment A string containing the http address of the server running
+ :param environment: A string containing the http address of the server running
the NRP
"""
@@ -95,8 +95,8 @@ class Config(dict):
Internal helper to validate that a key with given list of values/sub-keys is
present in the config. Raise an exception if the key or any values are missing.
- :param key A string representing the high level group to check for in the config.
- :param values A list of sub-keys to check under the parent key.
+ :param key: A string representing the high level group to check for in the config.
+ :param values: A list of sub-keys to check under the parent key.
"""
if key not in self:
diff --git a/hbp_nrp_virtual_coach/pynrp/simulation.py b/hbp_nrp_virtual_coach/pynrp/simulation.py
index dc30bcc..ea5b829 100644
--- a/hbp_nrp_virtual_coach/pynrp/simulation.py
+++ b/hbp_nrp_virtual_coach/pynrp/simulation.py
@@ -277,7 +277,8 @@ class Simulation(object):
def __on_error(self, msg):
"""
Function to log ROS CLE error messages.
- :param msg A CLEError message
+
+ :param msg: A CLEError message
"""
error_msg = "There was a %(type)s error resulting from the %(source)s." \
" The full error is below:\n %(msg)s" % {'type': msg['errorType'],
--
GitLab