clickhouse.rs icon indicating copy to clipboard operation
clickhouse.rs copied to clipboard
verified publisher icon loyd

Enforce API documentation

Open pravic opened this issue 1 year ago • 2 comments

Summary

Currently almost nobody documents added functions which is not good for the users of this library - but the API must have documentation.

Let's warn about missing docs (deny would be even better).

pravic avatar Sep 26 '24 04:09 pravic

Guys? @slvrtrn @loyd

More and more PRs are merged, but nobody cares about maintaining the API documentation.

pravic avatar Dec 04 '24 21:12 pravic

More and more PRs are merged, but nobody cares about maintaining the API documentation.

I agree; we need to force the creation of documentation for all new extensions. But we cannot just merge this PR and break CI. This check must be enabled, but only after adding all missing docs.

loyd avatar Dec 05 '24 13:12 loyd