Added support for using sea-orm with #[deny(missing_docs)]

[emirror-de]

As discussed in #1472, this PR addresses the issue to allow #[deny(missing_docs)] in crates having sea-orm as dependency by adding #[doc = " Generated by sea-orm-macros"] to derived types/variants/fields in sea-orm-macros.

PR Info

• Closes DeriveActiveEnum is incompatible with deny(missing_docs) attribute #1472

New Features

• Enables crates using sea-orm to use #[deny(missing_docs)].

[billy1624]

Hey @emirror-de, thanks for contributing!! Is this ready? Please click "Ready for review" once it's.

A nitpick: I wonder why there is a space before the documentation? #[doc = " Generated by sea-orm-macros"] Is there any reason behind it?

[emirror-de]

Thanks for the review! I added it as draft to have a base for discussion and I was not sure if I missed something.

A nitpick: I wonder why there is a space before the documentation? #[doc = " Generated by sea-orm-macros"] Is there any reason behind it?

It is just a matter of style:

#[doc = " Generated by sea-orm-macros"] expands to /// Generated by sea-orm-macros while

#[doc = "generated by sea-orm-macros"] expands to ///generated by sea-orm-macros in source code.

The latter has been proposed in the corresponding issue. I personally prefer the first one, but I am happy to align it with the way it fits best for sea-orm.

I was also thinking in moving missing_docs from warn to deny in sea-orm and maybe add it to all the other crates that are currently missing it? But I am not sure if that is out of scope here?

[tyt2y3]

#[doc = " Generated by sea-orm-macros"] expands to /// Generated by sea-orm-macros while

Interesting observation. I agree.

[tyt2y3]

I was also thinking in moving missing_docs from warn to deny in sea-orm and maybe add it to all the other crates that are currently missing it? But I am not sure if that is out of scope here?

May be we can enable this in one of our tests or examples, so as to prove the point. And we will be able to catch it in our CI moving forward. But not changing it in sea-orm itself.

[emirror-de]

May be we can enable this in one of our tests or examples, so as to prove the point. And we will be able to catch it in our CI moving forward. But not changing it in sea-orm itself.

OK, so you suggest adding a project to the examples with:

Cargo.toml

[dependencies]
sea-orm = { path = "../../", features = ["default"] }

lib.rs

//! Denying missing docs test.
#![deny(missing_docs)]

If I understood you correctly?

[tyt2y3]

Yes. Or we can simply hijack the basic example. It has no other external dependency (no web framework etc), so I think it will work.

[billy1624]

Hey @emirror-de, thanks for the CI update! I find there are more to be done. Adding #![deny(missing_docs)] alone won't catch it. We need to make the entity module as public in order to properly test it.

I'm going to take on the task :)