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

Add method documentation #63

Merged
merged 6 commits into from
Sep 11, 2024

Conversation

negvet
Copy link
Contributor

@negvet negvet commented Sep 5, 2024

No description provided.

Copy link

codecov bot commented Sep 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.29%. Comparing base (f637a5f) to head (2a29cb3).
Report is 3 commits behind head on releases/1.1.0.

Additional details and impacted files
@@                Coverage Diff                 @@
##           releases/1.1.0      #63      +/-   ##
==================================================
+ Coverage           93.65%   94.29%   +0.64%     
==================================================
  Files                  26       27       +1     
  Lines                1638     1857     +219     
==================================================
+ Hits                 1534     1751     +217     
- Misses                104      106       +2     
Flag Coverage Δ
dev-py310 94.29% <ø> (+0.64%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@negvet negvet marked this pull request as ready for review September 9, 2024 16:28
Copy link
Contributor

@goodsong81 goodsong81 left a comment

Choose a reason for hiding this comment

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

Looks all good to me but why don't you add a link to docs/source/index.rst as well so that this page could be accessible directly?

  • Getting Started
  • User Guide
  • [XAI Method?]
  • API Manual
  • Coding Guide

Hmm, it might be semantically a subsection of the user guide.
I have no hard preference. Feel free to ignore.

@goodsong81 goodsong81 changed the base branch from develop to releases/1.1.0 September 10, 2024 06:53
@goodsong81 goodsong81 added this to the 1.1.0 milestone Sep 10, 2024
@negvet
Copy link
Contributor Author

negvet commented Sep 10, 2024

Hmm, it might be semantically a subsection of the user guide.

This is a good suggestion, I followed it.
Initially, I assumed that it might be too big, but probably it is fine.

Copy link
Contributor

@goodsong81 goodsong81 left a comment

Choose a reason for hiding this comment

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

LGTM!

@negvet negvet merged commit a95e871 into openvinotoolkit:releases/1.1.0 Sep 11, 2024
5 of 6 checks passed
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