cve-bin-tool icon indicating copy to clipboard operation
cve-bin-tool copied to clipboard

docs: Add docstrings to cve_bin_tool/data_sources/osv_source.py

Open abhijeetsourav opened this issue 1 year ago • 4 comments

------------------------------------------------------------- Detailed Coverage --------------------------------------------------------------

Name Status
osv_source.py
OSV_Source (L23) MISSED
OSV_Source.update_ecosystems (L49) COVERED
OSV_Source.get_ecosystem (L69) COVERED
OSV_Source.get_ecosystem_incremental (L79) COVERED
OSV_Source.parse_filename (L108) MISSED
OSV_Source.get_newfiles (L121) COVERED
OSV_Source.get_totalfiles (L137) COVERED
OSV_Source.fetch_cves (L153) COVERED
OSV_Source.update_cve_entries (L219) COVERED
OSV_Source.format_data (L243) MISSED
OSV_Source.get_cve_data (L361) MISSED
----------------------------------------------------------------------------------------- --------------------------------------------------

------------------------------------------------------------------ Summary -------------------------------------------------------------------

Name Total Miss Cover Cover%
osv_source.py 11 4 7 64%
------------------------------------ ------------------------- ------------------------ ------------------------- --------------------------
TOTAL 11 4 7 63.6%
----------------------------------------------- RESULT: FAILED (minimum: 80.0%, actual: 63.6%) --------------------------------------------

abhijeetsourav avatar Feb 16 '24 21:02 abhijeetsourav

@terriko can i add the docstrings to this file?

abhijeetsourav avatar Feb 16 '24 21:02 abhijeetsourav

hi, i am new to the community, can i work on this issue @abhijeetsourav ?

ranjanmangla1 avatar Feb 17 '24 04:02 ranjanmangla1

@ranjanmangla1 i am working on this. You can create a new issue for adding docstrings to a file which is missing it. see #3773

abhijeetsourav avatar Feb 17 '24 06:02 abhijeetsourav

@terriko can I add docstrings to this file ??

lavi20 avatar Feb 24 '24 02:02 lavi20

Docs has been added in the provided pull request for the missing functions/methods #3871

abhijeetsourav avatar Mar 08 '24 06:03 abhijeetsourav