Skip to content

Commit

Permalink
Fix docstrings
Browse files Browse the repository at this point in the history
This commit fixes docstrings which contain outdated information
  • Loading branch information
tobiasah committed Sep 20, 2024
1 parent 93ea3d7 commit 1814adb
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 5 deletions.
2 changes: 1 addition & 1 deletion src/labone/core/errors.py
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ def raise_streaming_error(err: hpk_schema.Error) -> None:
err: The streaming error to be converted.
Raises:
The converted error.
LabOneCoreError: The converted error.
"""
raise _ZI_ERROR_MAP.get(err.kind, LabOneCoreError)( # type: ignore[call-overload]
err.message,
Expand Down
2 changes: 1 addition & 1 deletion src/labone/core/kernel_session.py
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,8 @@ class KernelSession(Session):
Args:
core_session: The underlying zhinst.comms session.
context: The context in which the session is running.
kernel_info: Information about the target kernel.
server_info: Information about the target data server.
capability_version: The capability version the server reported.
"""

def __init__(
Expand Down
2 changes: 0 additions & 2 deletions src/labone/core/value.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,6 @@ class AnnotatedValue:
path: Absolute node path.
timestamp: Timestamp at which the device sent the value.
(Only relevant for received values.)
extra_header: For some types of vector nodes, additional information
regarding the data. None otherwise.
"""

value: Value
Expand Down
6 changes: 5 additions & 1 deletion src/labone/mock/automatic_server.py
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,11 @@ async def set(
path: LabOneNodePath,
) -> AnnotatedValue: ...

async def set(self, value: AnnotatedValue | Value, path="") -> AnnotatedValue:
async def set(
self,
value: AnnotatedValue | Value,
path: str = "",
) -> AnnotatedValue:
"""Predefined behaviour for set.
Updates the internal dictionary. A set command is considered
Expand Down

0 comments on commit 1814adb

Please sign in to comment.