Merge pull request #174 from tiqi-group/doc/fixes_docstring

fixes docstring of add_prefix_to_full_access_path
This commit is contained in:
Mose Müller 2024-10-03 11:00:26 +02:00 committed by GitHub
commit 843675fa1e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 4 additions and 4 deletions

View File

@ -1,6 +1,6 @@
[tool.poetry] [tool.poetry]
name = "pydase" name = "pydase"
version = "0.10.6" version = "0.10.7"
description = "A flexible and robust Python library for creating, managing, and interacting with data services, with built-in support for web and RPC servers, and customizable features for diverse use cases." description = "A flexible and robust Python library for creating, managing, and interacting with data services, with built-in support for web and RPC servers, and customizable features for diverse use cases."
authors = ["Mose Mueller <mosmuell@ethz.ch>"] authors = ["Mose Mueller <mosmuell@ethz.ch>"]
readme = "README.md" readme = "README.md"

View File

@ -592,7 +592,7 @@ def add_prefix_to_full_access_path(
object. object.
Args: Args:
data: serialized_obj:
The serialized object to process. The serialized object to process.
prefix: prefix:
The prefix string to prepend to each full access path. The prefix string to prepend to each full access path.
@ -602,7 +602,7 @@ def add_prefix_to_full_access_path(
Example: Example:
```python ```python
>>> data = { >>> serialized_obj = {
... "full_access_path": "", ... "full_access_path": "",
... "value": { ... "value": {
... "item": { ... "item": {
@ -612,7 +612,7 @@ def add_prefix_to_full_access_path(
... } ... }
... } ... }
... ...
... modified_data = add_prefix_to_full_access_path(data, 'prefix') ... modified_data = add_prefix_to_full_access_path(serialized_obj, 'prefix')
{"full_access_path": "prefix", "value": {"item": {"full_access_path": {"full_access_path": "prefix", "value": {"item": {"full_access_path":
"prefix.some_item_path", "value": 1.0}}} "prefix.some_item_path", "value": 1.0}}}
``` ```