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: Clarifying use of --metrics and epss options #3663

Merged
merged 5 commits into from
Jan 3, 2024

Conversation

Mayankrai449
Copy link
Contributor

  • Added documentation clarifying automatic activation of --metrics.
  • Updated epss related help

@Mayankrai449
Copy link
Contributor Author

Mayankrai449 commented Dec 23, 2023

@terriko Can you please provide a feedback, so I can further improve my documentation work.

Copy link
Contributor

@terriko terriko left a comment

Choose a reason for hiding this comment

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

A few changes to make this shorter and clearer. Note that I updated your branch to address a test issue, so you should be able to get to the point where all tests pass and this can be merged if you keep the updated branch!

cve_bin_tool/cli.py Outdated Show resolved Hide resolved
doc/MANUAL.md Outdated Show resolved Hide resolved
@codecov-commenter
Copy link

codecov-commenter commented Dec 28, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (bf9afe9) 78.98% compared to head (ed97c4c) 79.42%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3663      +/-   ##
==========================================
+ Coverage   78.98%   79.42%   +0.44%     
==========================================
  Files         797      797              
  Lines       11927    11927              
  Branches     1602     1602              
==========================================
+ Hits         9420     9473      +53     
+ Misses       2075     2022      -53     
  Partials      432      432              
Flag Coverage Δ
longtests 78.73% <ø> (+0.42%) ⬆️
win-longtests 77.24% <ø> (+0.39%) ⬆️

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.

Mayankrai449 and others added 2 commits December 29, 2023 02:26
Co-authored-by: Terri Oda <terri@toybox.ca>
Co-authored-by: Terri Oda <terri@toybox.ca>
@Mayankrai449
Copy link
Contributor Author

@terriko committed the requested changes with updated branch. 👍

Copy link
Contributor

@terriko terriko left a comment

Choose a reason for hiding this comment

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

Looking good now. I'm going to update the branch again to try to fix the tests so this can be merged, but you might have to wait until tomorrow since I'm at the end of my work day!

Copy link
Contributor

@terriko terriko left a comment

Choose a reason for hiding this comment

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

Looks like we're set to merge now. Thank you for both the PR and your patience with our test failures!

@terriko terriko merged commit 32a62cd into intel:main Jan 3, 2024
20 of 21 checks passed
@Mayankrai449 Mayankrai449 deleted the mayankrai/docs_update branch January 10, 2024 09:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: Clarify use of --metrics and epss options
3 participants