Closed jan-janssen closed 1 week ago
The changes involve modifications to function signatures and documentation across several files in the pysqa
module. Key updates include altering return types to allow for more flexible outputs, such as introducing None
as a possible return value. Additionally, some class documentation has been refined, with specific attributes removed from the docstrings, while new docstrings have been added to clarify class purposes.
Files | Change Summary |
---|---|
pysqa/ext/modular.py |
Updated submit_job function signature to return Union[int, None] . Added import for Union from typing . |
pysqa/utils/basic.py |
Removed attribute documentation for config , queue_list , queue_view , and queues in BasisQueueAdapter class. |
pysqa/utils/core.py |
Added docstring to CoreQueueAdapter class describing its purpose and parameters. |
pysqa/utils/validate.py |
Changed _memory_spec_string_to_value parameter value from str to Union[str, int, float] . |
pysqa/wrapper/gent.py |
Modified convert_queue_status method signature to return Union[pandas.DataFrame, None] . Added import for Union from typing . |
sequenceDiagram
participant User
participant QueueSystem
User->>QueueSystem: Submit Job
QueueSystem->>User: Return Job ID or None
🐰 Hopping through the code, oh what a sight,
With changes so clever, making things right.
Functions now flexible, docs shining bright,
In the land ofpysqa
, all feels just right!
Let's celebrate with a joyful cheer,
For every little change, brings us near! 🌟
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
Summary by CodeRabbit
New Features
submit_job
andconvert_queue_status
can now returnNone
).CoreQueueAdapter
class.Bug Fixes
Documentation
BasisQueueAdapter
class to streamline information.