Skip to content
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.

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

List default execution scripts #399

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Conversation

FedericoNegri
Copy link
Contributor

No description provided.

@github-actions github-actions bot added the enhancement New features or code improvements label May 17, 2024
Copy link

codecov bot commented May 17, 2024

Codecov Report

Attention: Patch coverage is 95.65217% with 1 lines in your changes are missing coverage. Please review.

Project coverage is 93.95%. Comparing base (b01c0cb) to head (e8ec192).

Files Patch % Lines
src/ansys/hps/client/jms/api/project_api.py 88.88% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #399      +/-   ##
==========================================
+ Coverage   93.91%   93.95%   +0.04%     
==========================================
  Files          66       66              
  Lines        2498     2515      +17     
==========================================
+ Hits         2346     2363      +17     
  Misses        152      152              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@@ -81,14 +82,26 @@ def fs_url(self) -> str:
self._fs_url = _find_available_fs_url(self.get_storage())
return self._fs_url

def get_api_info(self):
def get_api_info(self) -> dict:
"""Get information of the JMS API that the client is connected to.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"""Get information of the JMS API that the client is connected to.
"""Get information on the JMS API that the client is connected to.

"of the JMS API" didn't read well. Hope "on the JMS API" is OK.

"""Get information of the JMS API that the client is connected to.

Information includes the version and build date.
"""
r = self.client.session.get(self.url)
return r.json()

@property
def api_info(self) -> dict:
"""Information of the JMS API that the client is connected to."""
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"""Information of the JMS API that the client is connected to."""
"""Information on the JMS API that the client is connected to."""


You can use the method :meth:`JmsApi.list_default_execution_scripts` to query
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You can use the method :meth:`JmsApi.list_default_execution_scripts` to query
You can use the :meth:`JmsApi.list_default_execution_scripts` method to query

Noun indicating the type of object should follow the tagged code entity.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New features or code improvements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants