Skip to content

Add descriptions of 'size' and 'item_uid' parameters to docstring for 'history_clear' API #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dmgav merged 1 commit into from
Dec 5, 2025
Merged

Add descriptions of 'size' and 'item_uid' parameters to docstring for 'history_clear' API #57

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions bluesky_queueserver_api/api_docstrings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1530,6 +1530,15 @@ def condition(status):

Parameters
----------
size: int (optional)
The new size of the history. If the size is 0 or less, then the history is
cleared. If the size is greater than or equal to size of the queue, then the queue is
not modified and ``plan_history_uid`` remains unchanged. Otherwise the history is
trimmed to the desired size. Default: ``None``.
item_uid: str (optional)
If the history contains an item with **item_uid**, then the history is trimmed by
removing this item and all older items. If the item with **item_uid** is not found
then the history and **plan_history_uid** remain unchanged. Default: ``None``.
lock_key: str or None (optional)
The lock key enables access to the API when RE Manager queue is locked.
If the parameter is not ``None``, the key overrides the current lock key set by
Expand Down
Loading