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

Updating API documentation #194

Merged
merged 2 commits into from
Oct 23, 2023
Merged

Updating API documentation #194

merged 2 commits into from
Oct 23, 2023

Conversation

ansnfernand
Copy link
Collaborator

Feedbacks from Pouya

Checklist:

  • Run unit tests and make sure they all pass
    N/A Check and fix style errors
    - pre-commit command line check
    - Problems tab in PyCharm
    N/A Bench test new/modified APIs by using and modifying the code in the example for the API method
    N/A Add new methods to rst file for updated API script(\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 and can be connected to using gRPC

Feedbacks from Pouya
@codecov
Copy link

codecov bot commented Oct 20, 2023

Codecov Report

Merging #194 (efca7f9) into main (e5befb1) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #194   +/-   ##
=======================================
  Coverage   56.17%   56.17%           
=======================================
  Files          20       20           
  Lines        3217     3217           
=======================================
  Hits         1807     1807           
  Misses       1410     1410           
Files Coverage Δ
src/ansys/sherlock/core/lifecycle.py 54.36% <ø> (ø)

doc/source/user_guide/index.rst Outdated Show resolved Hide resolved
src/ansys/sherlock/core/parts.py Outdated Show resolved Hide resolved
@ansnfernand ansnfernand merged commit 3cb979f into main Oct 23, 2023
25 checks passed
@ansnfernand ansnfernand deleted the apiDocsFeedbacks branch October 23, 2023 14:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants