Reformat some function param docs for consistency

ethereum / c-kzg-4844

A minimal implementation of the Polynomial Commitments API for EIP-4844 and EIP-7594, written in C.

Apache License 2.0

112 stars 105 forks source link

Reformat some function param docs for consistency #496

Closed jtraglia closed 3 weeks ago

jtraglia commented 1 month ago

There were some functions using a single space vs a tab (of spaces) between the params.

jtraglia commented 1 month ago

There were some minor changes. Please review the diff with "hide whitespace changes" to see them.

asn-d6 commented 1 month ago

I think the style convention of the function documentation params frequently adds a review roundtrip. Is it possible to automatically format them?

Personally, I don't feel strong at all about this, and I'm OK with merging this PR anyway.

jtraglia commented 1 month ago

Is it possible to automatically format them?

I wish. To my knowledge, so such tool exists for C. One might be able to write their own clang-tidy checker. But I imagine that would involve quite a bit of work.