doc

doc() 함수는 프로젝트의 docs-paths에 정의된 마크다운 문서 블록(documentation block)을 참조해서, 모델·소스·컬럼 등의 description에 그 내용을 주입하는 데 사용해요. 문서 블록은 .md 파일 안에서 {% docs %}...{% enddocs %}로 정의해요.

출처: 문서

본문

먼저 markdown 폴더에 문서 블록을 정의해요. 예를 들어 models/orders.md에:

{% docs orders %}

This table contains all info about orders.

{% enddocs %}

그런 다음 property 파일에서 {{ doc('orders') }}로 참조하면 그 내용이 해당 리소스의 설명으로 들어가요.

models:
  - name: orders
    description: "{{ doc('orders') }}"

doc() 참조는 SQL 안에서는 사용할 수 없고, 주로 properties.yml의 description 필드에 사용돼요. 문서 블록 이름은 프로젝트 안에서 유일해야 해요. 해당 이름이 없으면 컴파일 에러가 발생해요.

더 알아보기 (Learn more)

문서화에 대한 자세한 내용은 Documentation을 참조하세요.