Skip to content

Commit

Permalink
Fix rendering of snippet for run results JSON file (#5816)
Browse files Browse the repository at this point in the history
[Preview](https://docs-getdbt-com-git-dbeatty10-patch-2-1-dbt-labs.vercel.app/reference/artifacts/run-results-json)

## What are you changing in this pull request and why?

It currently looks like
[this](https://docs.getdbt.com/reference/artifacts/run-results-json):

<img width="600" alt="image"
src="https://github.com/user-attachments/assets/2250f0dc-68c5-4675-a081-c4cabbf78726">

When it should look more like
[this](https://docs.getdbt.com/reference/dbt-classes):

<img width="600" alt="image"
src="https://github.com/user-attachments/assets/736cd3b4-3705-43d9-b430-7b1df3ff5946">

> [!NOTE]  
> There is an extra newline between bullet points due to the snippet,
but I wasn't able to make it go away after a [couple
attempts](https://github.com/dbt-labs/docs.getdbt.com/pull/5816/commits).
>
> If we want to eliminate the extra newline, we'd either need to go away
from using a snippet or figure out how to make the snippet place nice.

## Checklist
- [x] Review the [Content style
guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md)
so my content adheres to these guidelines.

---------

Co-authored-by: Mirna Wong <[email protected]>
  • Loading branch information
dbeatty10 and mirnawong1 authored Jul 23, 2024
1 parent 9169110 commit 9c50749
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion website/docs/reference/artifacts/run-results-json.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,8 @@ Each entry in `results` is a [`Result` object](/reference/dbt-classes#result-obj
- `execution_time`: Total time spent executing this node
- `timing`: Array that breaks down execution time into steps (often `compile` + `execute`)
- `message`: How dbt will report this result on the CLI, based on information returned from the database
import RowsAffected from '/snippets/_run-result.md';

import RowsAffected from '/snippets/_run-result.md';

<RowsAffected/>

Expand Down

0 comments on commit 9c50749

Please sign in to comment.