style: correct and clarify docs and comments

ref: N25B-168
2025-10-16 22:03:50 +02:00
parent 4c3aa3a911
commit 45be0366ba
3 changed files with 4 additions and 3 deletions
--- a/src/robot_interface/endpoints/socket_base.py
+++ b/src/robot_interface/endpoints/socket_base.py
@@ -61,7 +61,8 @@ class SocketBase(object):
        """
        Description of the endpoint. Used for negotiation.

-        :return: A dictionary with the following keys: name, port, pattern, data_type. See https://utrechtuniversity.youtrack.cloud/articles/N25B-A-14/RI-CB-Communication#negotiation
+        :return: A dictionary with the following keys: id, port, bind. See API specification at:
+        https://utrechtuniversity.youtrack.cloud/articles/N25B-A-14/RI-CB-Communication#negotiation
        :rtype: dict
        """
        return {