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: fix docs #498

Merged
merged 8 commits into from
Jan 7, 2025
Merged

docs: fix docs #498

merged 8 commits into from
Jan 7, 2025

Conversation

Two-Hearts
Copy link
Contributor

@Two-Hearts Two-Hearts commented Dec 24, 2024

While using methods from notation-go, I noticed that many of the function docs in the library are not accurate.

This PR fixes and cleans up these issues.

Signed-off-by: Patrick Zheng <[email protected]>
Copy link

codecov bot commented Dec 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.46%. Comparing base (e5eef5e) to head (d6649de).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #498      +/-   ##
==========================================
- Coverage   80.47%   80.46%   -0.01%     
==========================================
  Files          35       35              
  Lines        3344     3343       -1     
==========================================
- Hits         2691     2690       -1     
  Misses        508      508              
  Partials      145      145              

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

JeyJeyGao
JeyJeyGao previously approved these changes Dec 24, 2024
Copy link
Contributor

@JeyJeyGao JeyJeyGao left a comment

Choose a reason for hiding this comment

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

LGTM

@shizhMSFT shizhMSFT changed the title fix: update blob sign docs: update blob sign Dec 24, 2024
shizhMSFT
shizhMSFT previously approved these changes Dec 24, 2024
Copy link
Contributor

@shizhMSFT shizhMSFT left a comment

Choose a reason for hiding this comment

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

LGTM with suggestions. BTW, it is docs while fix means bug fixes.

notation.go Outdated Show resolved Hide resolved
signer/plugin_test.go Show resolved Hide resolved
@Two-Hearts Two-Hearts changed the title docs: update blob sign docs: update docs related to blob Dec 25, 2024
@Two-Hearts Two-Hearts changed the title docs: update docs related to blob docs: update docs Dec 25, 2024
Signed-off-by: Patrick Zheng <[email protected]>
@Two-Hearts Two-Hearts dismissed stale reviews from shizhMSFT and JeyJeyGao via 3908b4e December 25, 2024 03:25
@Two-Hearts Two-Hearts changed the title docs: update docs docs: fix docs Dec 25, 2024
Signed-off-by: Patrick Zheng <[email protected]>
Signed-off-by: Patrick Zheng <[email protected]>
JeyJeyGao
JeyJeyGao previously approved these changes Dec 25, 2024
Copy link
Contributor

@JeyJeyGao JeyJeyGao left a comment

Choose a reason for hiding this comment

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

LGTM

example_verifyBlob_test.go Outdated Show resolved Hide resolved
verifier/helpers.go Show resolved Hide resolved
Signed-off-by: Patrick Zheng <[email protected]>
Signed-off-by: Patrick Zheng <[email protected]>
@Two-Hearts Two-Hearts requested a review from shizhMSFT December 26, 2024 05:18
@Two-Hearts Two-Hearts requested a review from JeyJeyGao December 26, 2024 05:18
Copy link
Contributor

@shizhMSFT shizhMSFT left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@JeyJeyGao JeyJeyGao left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@priteshbandi priteshbandi left a comment

Choose a reason for hiding this comment

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

LGTM

@Two-Hearts Two-Hearts merged commit 26ce089 into notaryproject:main Jan 7, 2025
9 checks passed
@Two-Hearts Two-Hearts deleted the blob branch January 7, 2025 00:36
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.

4 participants