Skip to content

Conversation

@samvandevelde
Copy link

This PR fixes tiny issues with the README.md file I just spotted while checking out PQ-libraries.

  • commit 1: fixes hyperlink
  • commit 2: removes information about dagger symbol (†) as this symbol is no longer used since commit 796aa12.
  • Does this PR change the input/output behaviour of a cryptographic algorithm (i.e., does it change known answer test values)? (If so, a version bump will be required from x.y.z to x.(y+1).0.)
  • Does this PR change the list of algorithms available -- either adding, removing, or renaming? Does this PR otherwise change an API? (If so, PRs in fully supported downstream projects dependent on these, i.e., oqs-provider will also need to be ready for review and merge by the time this is merged. Also, make sure to update the list of algorithms in the continuous benchmarking files: .github/workflows/kem-bench.yml and sig-bench.yml)

-> No AI has been used for this tiny fix.

@samvandevelde samvandevelde marked this pull request as ready for review November 20, 2025 16:06
@xuganyu96
Copy link
Contributor

I am the author of the algorithm support table. Thank you for catching this issue and proposing a contribution!

Unfortunately this fix is not sufficient. The algorithm support table in the top-level README.md is generated by code. You can find the logic under scripts/update_alg_support_table.py. The standardization status data can be found under docs/algorithms/<kem|sig|stfl_sig>/*.yml files. Furthermore, slh_dsa.yml is generated from src/sig/slh_dsa/templates/slh_dsa_docs_yml_template.jinja by copy_from_slh_dsa_c.py. A complete fix would probably also involve fixing the Jinja template.

Please let me know if you need help. Cheers.

@xuganyu96 xuganyu96 self-requested a review November 25, 2025 03:27
@samvandevelde
Copy link
Author

Didn't catch the README was generated, was just a quick PR from skimming all the available libs so didn't get further into it than README and src dir. I do feel responsible now for a proper fix, will ping you when the work's done. Thanks for the catch!

samvandevelde and others added 2 commits November 25, 2025 18:06
Instead of removing the spec_data from FIPS 205 (it is more correct than the way the link is already embedded in the documentation from PQClean), I wrote a tiny function that attempts to format the hyperlink as to only cover the word NIST/IRTF/ISO

Signed-off-by: prismaman <[email protected]>
@coveralls
Copy link

Coverage Status

coverage: 83.586% (-0.01%) from 83.596%
when pulling 7c4cea4 on samvandevelde:fix-readme
into 39ea281 on open-quantum-safe:main.

Copy link
Contributor

@xuganyu96 xuganyu96 left a comment

Choose a reason for hiding this comment

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

LGTM. Nice work!

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.

3 participants