Add a test that descriptions have a minimum length

[ttusing]

Describe the feature

The current fct_documentation_coverage test accepts any description. Sometimes, descriptions are as good as empty, such as "TODO", "model_name", " ". I propose either adding one or more optional parameters, such as minimum description character length, to fct_documentation_coverage to count short descriptions as not descriptions, or adding another model/test that tests for "good descriptions", with optional configuration parameters to apply to any of models, seeds, sources, snapshots, exposures.

The test would fail descriptions in these circumstances:

• the description is less than X characters (tunable) (and if set to 0, disable this test. maybe 0 is the default, maybe 10).
• if the model name is found in the description, remove that substring from character count
• Remove spaces and special characters from description string before counting

Describe alternatives you've considered

• Accepting bad descriptions and that no enforcement will encourage people to write thoughtful descriptions XD

Additional context

Unsure if string replacement is consistent across databases/adapters, may need to exclude from feature.

Who will this benefit?

People who want better documentation in their project

Are you interested in contributing this feature?

Yes! I can add this no problem.

[b-per]

Hi @ttusing !

My first feeling is that this looks a bit too "specific" to be a generic test that many people would want to implement.

In that case I think that it would make more sense for you to build your own fct + test with your own company logic. What do you think? And in that case, do you know how to create those on your side or would you like some guidance?

[ttusing]

Hi @ttusing !

My first feeling is that this looks a bit too "specific" to be a generic test that many people would want to implement.

In that case I think that it would make more sense for you to build your own fct + test with your own company logic. What do you think? And in that case, do you know how to create those on your side or would you like some guidance?

I can totally do that~. Might open source some of our tests in a package and include this :)