@mirnawong1 I'm re-opening this because #6940 doesn't match the intent of this issue.

#6193 describes (3) totally different ways to add a description to data tests:

1. Definitions of generic data tests
2. Instances of generic data tests
3. Instances of singular data tests

#6940 provides good examples of (2) 💡
But this issue is asking for an example of (1) 👈

What's the difference between a definition and an instance?

• By "definition", I mean the Jinja macro that provides the code/logic for the data test (independent of that data test actually being used anywhere).
• By "instance", I mean the YAML where the data test is actually added to a model/seed/etc.

So for (2), we'll want our docs to include an example of adding a description to the macro associated with the data test like this:

macros:
  - name: test_not_empty_string
    description: Complementary test to default `not_null` test as it checks that there is not an empty string. It only accepts columns of type string. It is deprecated as this functionality has been included in the custom implementation of `not_null`
    arguments:
      - name: model
        type: string
        description: Model Name
      - name: column_name
        type: string
        description: Column name that should not be an empty string

👉 Note that the description here is under the macros: key.

oh i see, its about the jinja macro! ok got it, thank you for clarifying!

hey @dbeatty10 ! ok i've created this pr #6944, which hopefully addresses this issue. mind having a look when you can? no rush of course

https://docs-getdbt-com-git-add-generic-test-macro-dbt-labs.vercel.app/best-practices/writing-custom-generic-tests#add-description-to-generic-data-test-logic