Skip to content

Commit e11ae05

Browse files
committed
Fixed hyperlinks in app mngr
1 parent 992a172 commit e11ae05

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

app/core/app_manager.py

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ def init_app(self):
3434
@log_initialise('device')
3535
def register_device(self, config: dict) -> Response:
3636
"""
37-
Register a new device.
38-
For reference, see https://github.com/SmartBioTech/DeviceControl/wiki/End-Points#device-initiation
37+
Register a new device (see
38+
`details <https://github.com/SmartBioTech/DeviceControl/wiki/End-Points#device-initiation>`__).
3939
4040
:param config: A dictionary with pre-defined keys
4141
:return: Response object
@@ -73,8 +73,8 @@ def end_device(self, device_id: str) -> Response:
7373

7474
def command(self, config: dict) -> Response:
7575
"""
76-
Run a specific command.
77-
For reference, see https://github.com/SmartBioTech/DeviceControl/wiki/End-Points#command
76+
Run a specific command (see
77+
`details <https://github.com/SmartBioTech/DeviceControl/wiki/End-Points#command>`__).
7878
7979
:param config: A dictionary with pre-defined keys
8080
:return: Response object
@@ -103,8 +103,8 @@ def command(self, config: dict) -> Response:
103103
@log_initialise('task')
104104
def register_task(self, config: dict) -> Response:
105105
"""
106-
Register a new task.
107-
For reference, see https://github.com/SmartBioTech/DeviceControl/wiki/End-Points#task-initiation
106+
Register a new task (see
107+
`details <https://github.com/SmartBioTech/DeviceControl/wiki/End-Points#task-initiation>`__).
108108
109109
:param config: A dictionary with pre-defined keys
110110
:return: Response object
@@ -138,7 +138,8 @@ def end_task(self, task_id) -> Response:
138138

139139
def ping(self) -> Response:
140140
"""
141-
Test the application responsiveness.
141+
Get status information about the running devices and tasks (see
142+
`details <https://github.com/SmartBioTech/DeviceControl/wiki/End-Points#ping>`__).
142143
143144
:return: Response object
144145
"""
@@ -149,7 +150,8 @@ def ping(self) -> Response:
149150

150151
def get_data(self, config: dict) -> Response:
151152
"""
152-
Retrieves data in supported format as specified at https://github.com/SmartBioTech/DeviceControl/wiki/End-Points#get-data
153+
Retrieves data in supported format (see
154+
`details <https://github.com/SmartBioTech/DeviceControl/wiki/End-Points#get-data>`__).
153155
154156
:param config: A dictionary with pre-defined keys
155157
:return: Response object
@@ -190,7 +192,8 @@ def get_latest_data(self, config) -> Response:
190192
@log_terminate_all
191193
def end(self) -> Response:
192194
"""
193-
Ends the application. For reference, see https://github.com/SmartBioTech/DeviceControl/wiki/End-Points#end
195+
Ends the application (see
196+
`details <https://github.com/SmartBioTech/DeviceControl/wiki/End-Points#end>`__).
194197
195198
:return: Response object
196199
"""

0 commit comments

Comments
 (0)