From a902a637ee9ec1bd4fb10733fcb768f8ec25f579 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Leon=20M=C3=B6ller?= Date: Sat, 17 Feb 2024 17:44:16 +0100 Subject: [PATCH] adapter.aasx: improve `AASXWriter` docstring Replace a block of text by an `attention` admonition to highlight it properly. Furthermore, add a missing comma. --- basyx/aas/adapter/aasx.py | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/basyx/aas/adapter/aasx.py b/basyx/aas/adapter/aasx.py index 1c50feb3e..20eb41da7 100644 --- a/basyx/aas/adapter/aasx.py +++ b/basyx/aas/adapter/aasx.py @@ -285,9 +285,11 @@ class AASXWriter: file_store) writer.write_core_properties(cp) - **Attention:** The AASXWriter must always be closed using the :meth:`~.AASXWriter.close` method or its context - manager functionality (as shown above). Otherwise the resulting AASX file will lack important data structures - and will not be readable. + .. attention:: + + The AASXWriter must always be closed using the :meth:`~.AASXWriter.close` method or its context manager + functionality (as shown above). Otherwise, the resulting AASX file will lack important data structures + and will not be readable. """ AASX_ORIGIN_PART_NAME = "/aasx/aasx-origin"