PySDM icon indicating copy to clipboard operation
PySDM copied to clipboard

Introduce automatic checks for bibliography labels in Markdown and HTML

Open AgnieszkaZaba opened this issue 10 months ago • 2 comments

AgnieszkaZaba avatar May 06 '25 08:05 AgnieszkaZaba

Hi @AgnieszkaZaba @slayoo 👋,

This issue looks really interesting, and I'd love to contribute to it. Could you please assign it to me if it's still open for contributions?

Thanks!

zuberkhan01st avatar Jun 03 '25 06:06 zuberkhan01st

Hi @zuberkhan01st, help welcome! The point here is to develop a pre-commit hook which would check if all mentions in the code of a given paper from the bibliography are consistently formatted using the label given in the bibliography JSON file.

For instance, for the following entry: https://github.com/open-atmos/PySDM/blob/44a9b05d4da0fd04ae683cd2e1f9eea008ebfcad/docs/bibliography.json#L7 we would enforce: [Kessler 1969 (Meteorol. Monogr. 10)](https://doi.org/...) detecting typos or missing journal/volume information

AgnieszkaZaba avatar Jun 03 '25 10:06 AgnieszkaZaba