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

Jeff/doc template for troubleshooting #486

Open
wants to merge 27 commits into
base: main
Choose a base branch
from

Conversation

ansjmoody
Copy link
Collaborator

Description

Please provide a brief description of the changes made in this pull request.

Issue linked

Please mention the issue number or describe the problem this pull request addresses.

Checklist:

  • [] Run unit tests and make sure they all pass
    - Run tests without Sherlock running
    - Run tests with Sherlock GRPC connection
  • [] Check and fix style errors
    - pre-commit command line check
    - Problems tab in PyCharm
  • [] Bench test new/modified APIs by using and modifying the code in the example for the API method
  • [] Add new classes to rst files, located at: \doc\source\api
  • [] Generate documentation
  • [] Verify the HTML. It gets generated at: \doc\build\html.
    - Open index.html
    - Click on "API Reference" at the top.
    - Verify HTML for API changes.
  • [] Check that test code coverage is at least 80% when Sherlock is running
  • [] Make sure that the title of the pull request follows Commit naming conventions (e.g. feat: adding new PySherlock command)

@github-actions github-actions bot added dependencies Related with project dependencies documentation Improvements or additions to documentation maintenance Package and maintenance related labels Jan 17, 2025
Copy link

codecov bot commented Jan 17, 2025

Codecov Report

Attention: Patch coverage is 10.00000% with 27 lines in your changes missing coverage. Please review.

Project coverage is 59.82%. Comparing base (6227ba1) to head (2368ca7).
Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
src/ansys/sherlock/core/grpc_stub.py 10.52% 17 Missing ⚠️
src/ansys/sherlock/core/launcher.py 9.09% 10 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #486      +/-   ##
==========================================
- Coverage   60.07%   59.82%   -0.25%     
==========================================
  Files          21       21              
  Lines        5009     5033      +24     
==========================================
+ Hits         3009     3011       +2     
- Misses       2000     2022      +22     

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Related with project dependencies documentation Improvements or additions to documentation maintenance Package and maintenance related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants