search

pq-code-package / mlkem-native

High-assurance, high-performance ML-KEM implementation for mobile, pc, and server targets
https://pq-code-package.github.io/mlkem-native/dev/bench/
Apache License 2.0
11 stars 9 forks source link

Move all docstrings to header files #434

Open mkannwischer opened 2 days ago

mkannwischer commented 2 days ago

Originally docstrings were only in the C sources, but not in the header files. As a part of doing the CBMC proofs, we pulled most of the docstrings to the headers files, but not all. Now it is rather inconsistent, see e.g., https://github.com/pq-code-package/mlkem-native/blob/main/mlkem/polyvec.c This is quite upseting for my OCD.

@hanno-becker, do you agree that we move all docstrings to the header files? While we are at it should we enforce something else about the docstrings?

hanno-becker commented 2 days ago

@hanno-becker, do you agree that we move all docstrings to the header files?

Yes

While we are at it should we enforce something else about the docstrings?

We should make sure that the docstrings adhere to some common format that can be automatically turned into documentation. But I think that should be treated separately?