Skip to content

Commit

Permalink
Document clear_whole_buffer in args.
Browse files Browse the repository at this point in the history
  • Loading branch information
joaander committed Aug 26, 2024
1 parent bcce001 commit ed6a04e
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions hoomd/write/gsd_burst.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@ class Burst(GSD):
write_at_start (bool): When ``True`` **and** the file does not exist or
has 0 frames: write one frame with the current state of the system
when `hoomd.Simulation.run` is called. Defaults to ``False``.
clear_whole_buffer_after_dump (bool): When ``True`` the buffer is
emptied after calling `dump` each time. When ``False``, `dump` removes
frames from the buffer unil the ``end`` index. Defaults to ``True``.
Warning:
`Burst` errors when attempting to create a file or writing to one with
Expand Down Expand Up @@ -82,8 +85,8 @@ class Burst(GSD):
write_at_start = burst.write_at_start
clear_whole_buffer_after_dump (bool): When ``True`` the buffer is
emptied after calling `dump` each time. If ``False`` only frames in the
buffer until the end frame will be deleted. Defaults to ``True``.
emptied after calling `dump` each time. When ``False``, `dump` removes
frames from the buffer unil the ``end`` index.
.. rubric:: Example:
Expand Down

0 comments on commit ed6a04e

Please sign in to comment.