Skip to content

Conversation

michaelehab
Copy link
Contributor

Tasks

  • PR is descriptively titled 📑 and links the original issue above 🔗
  • Tests pass -- look for a green checkbox ✔️ a few minutes after opening your PR
    Run tests locally to check for errors.
  • Commits are in uniquely-named feature branch and has no merge conflicts 📁

Signed-off-by: Michael Ehab Mikhail <[email protected]>
Signed-off-by: Michael Ehab Mikhail <[email protected]>
Copy link
Member

@AyanSinhaMahapatra AyanSinhaMahapatra left a comment

Choose a reason for hiding this comment

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

@michaelehab LGTM, could you please merge from main and make sure the doc tests pass?

@keshav-space @TG1999 please take a look also.


.. note::
A PURL (Package URL) is a universal way to identify and locate software
packages. `More on PURL <https://github.com/package-url>`_
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
packages. `More on PURL <https://github.com/package-url>`_
packages. `More on PURL <https://github.com/package-url/purl-spec>`_

Let's use the spec repo URL

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the suggestion @AyanSinhaMahapatra
I updated the document to pass the doc tests, but for some reason, readthedocs tests keep failing.

Copy link
Member

@AyanSinhaMahapatra AyanSinhaMahapatra Aug 27, 2025

Choose a reason for hiding this comment

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

@michaelehab could you merge from main as requested above? I've fixed the RTD tests there with #210

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you so much, now all tests passed.

Signed-off-by: Michael Ehab Mikhail <[email protected]>
Copy link
Member

@AyanSinhaMahapatra AyanSinhaMahapatra left a comment

Choose a reason for hiding this comment

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

@michaelehab Thanks! See comments for your consideration, also check out the docs build at https://aboutcode--209.org.readthedocs.build/en/209/archive/gsoc/reports/2025/vulnerablecode_michael.html to review it looks the way you want it

Closing Thoughts
-------------------

This project was an exciting step forward from my 2024 GSoC work. By moving
Copy link
Member

Choose a reason for hiding this comment

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

Maybe link your previous GSoC 2024 page here, it's in the same sphinx docs so use https://www.sphinx-doc.org/en/master/usage/referencing.html#ref-role

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