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

docs: Updated documentation in update potting region. #477

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

Conversation

anskhanson
Copy link
Collaborator

Description

Updated example for update potting region.

Issue linked

Update potting region example is incorrect #476

Checklist:

  • [n/a] Run unit tests and make sure they all pass
    - Run tests without Sherlock running
    - Run tests with Sherlock GRPC connection
  • [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 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.
  • [n/a] 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)

@anskhanson anskhanson self-assigned this Dec 20, 2024
@anskhanson anskhanson requested a review from ansjmoody December 20, 2024 19:19
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Dec 20, 2024
Copy link

codecov bot commented Dec 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 60.22%. Comparing base (2a61d77) to head (50c577d).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #477   +/-   ##
=======================================
  Coverage   60.22%   60.22%           
=======================================
  Files          23       23           
  Lines        4983     4983           
=======================================
  Hits         3001     3001           
  Misses       1982     1982           

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

@ansjmoody ansjmoody modified the milestone: v0.9.0 Dec 20, 2024
@ansjmoody
Copy link
Collaborator

After this is completed, this commit should be cherry picked to the release/0.8 branch.

update_request1,
update_request2
]
)
Copy link
Collaborator

Choose a reason for hiding this comment

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

This line should be outdented.

update_request2
]
>>> return_codes = sherlock.layer.update_potting_region(request)
>>> all_requests = UpdatePottingRegionRequest(
Copy link
Collaborator

Choose a reason for hiding this comment

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

How about renaming all_requests to request, since it is a request object?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants