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

Check code examples for the docs config #4449

Open
1 task done
dbeatty10 opened this issue Nov 13, 2023 · 0 comments
Open
1 task done

Check code examples for the docs config #4449

dbeatty10 opened this issue Nov 13, 2023 · 0 comments
Labels
content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear

Comments

@dbeatty10
Copy link
Contributor

dbeatty10 commented Nov 13, 2023

Contributions

  • I have read the contribution docs, and understand what's expected of me.

Link to the page on docs.getdbt.com requiring updates

What part(s) of the page would you like to see updated?

1c959fd added a couple inline "to-do" comments like this:

So I'd suggest checking if each of these examples work correctly or not. If a code example works, then remove the to-do comment. If it doesn't, then update the docs as-needed.

Example 1 - Macros tab

macros/schema.yml

version: 2
macros:
  - name: macro_name
    docs:
      show: true | false

Example 2 - Macros properties page

version: 2

macros:
  - name: <macro name>
    [description](description): <markdown_string>
    [docs](docs):
      show: true | false
    arguments:
      - name: <arg name>
        type: <arg type>
        [description](description): <markdown_string>
      - ...
  - ...

Additional information

No response

@dbeatty10 dbeatty10 added content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear labels Nov 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear
Projects
None yet
Development

No branches or pull requests

1 participant