Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ability to document macros #1041

Closed
dwallace0723 opened this issue Oct 2, 2018 · 6 comments
Closed

Add ability to document macros #1041

dwallace0723 opened this issue Oct 2, 2018 · 6 comments
Labels
dbt-docs [dbt feature] documentation site, powered by metadata artifacts enhancement New feature or request

Comments

@dwallace0723
Copy link

Ability to

Feature description

Currently, dbt's native documentation functionality is built around the concept of documenting models. it would be equally as useful to have the ability to document macros.

Who will this benefit?

Anyone who leverages macros, especially within a large data org.

@ArvindEnvoy
Copy link

👍

@drewbanin
Copy link
Contributor

Thanks @dwallace0723. I figure we can:

  1. Enumerate the macros defined in a project
  2. Expose the macro code
  3. Expose models that call that macro

Do you imagine also writing markdown docs for macros? Or do you think that inline comments are sufficient? We don't currently have a mechanism for documenting macros, and I don't think it would make sense to extend the schema.yml syntax.

Maybe there's a tie-in here: #979?

@drewbanin drewbanin added enhancement New feature or request dbt-docs [dbt feature] documentation site, powered by metadata artifacts labels Oct 3, 2018
@dwallace0723
Copy link
Author

@drewbanin I do think there is a tie-in to #979. I think documenting the macro inline via a docs block would be a perfectly fine solution here.

@Fokko
Copy link
Contributor

Fokko commented Dec 16, 2019

Looking for this as well :-)

@drewbanin drewbanin added this to the Barbara Gittings milestone Dec 20, 2019
beckjake added a commit that referenced this issue Jan 31, 2020
@beckjake
Copy link
Contributor

beckjake commented Feb 3, 2020

Fixed in #2068

@beckjake beckjake closed this as completed Feb 3, 2020
@Fokko
Copy link
Contributor

Fokko commented Feb 3, 2020

Sweet! 👏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dbt-docs [dbt feature] documentation site, powered by metadata artifacts enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

5 participants