Fail the build if public method is missing rustdoc

[milenkovicm]

Is your feature request related to a problem or challenge? Please describe what you are trying to do.

As ballista moved towards library model having a good documentation and examples is becoming imperative. As the first step we should fail the build if public method does not have proper rustdoc.

Describe the solution you'd like

I believe there is similar functionality in datafusion repository, we can re-use it

Describe alternatives you've considered

Additional context

[killzoner]

Hey @milenkovicm I'm interested in picking this one
From my understanding, this would mean adding #![warn(missing_docs)] at the root of at least ballista/core, but this is not really doable right now (a lot of errors yield with this, and i'm not knowledgable enough to document the missing items)

As a first step alternative, I implemented documenting private items like this is done in datafusion. See #1327

[milenkovicm]

thank you @killzoner very much, will have a look later

[martin-g]

What do you think about enabling #![warn(missing_docs)] and adding /// TODO to fix all warnings?
Later whenever someone works on code with a TODO could improve it.
The benefit is that any new code will be checked and should be documented.

[milenkovicm]

i was hoping somebody would "vibe" comment the code :)

[killzoner]

That would be a lot of TODO indeed. I will look into what Claude can do on this front