Skip to content

Commit

Permalink
adapter.aasx: improve AASXWriter docstring
Browse files Browse the repository at this point in the history
Replace a block of text by an `attention` admonition to highlight it
properly. Furthermore, add a missing comma.
  • Loading branch information
jkhsjdhjs authored and s-heppner committed Feb 18, 2024
1 parent 0927305 commit a902a63
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions basyx/aas/adapter/aasx.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"

Expand Down

0 comments on commit a902a63

Please sign in to comment.