Skip to content

Commit ba74c72

Browse files
committed
Updates to grammar and some text formatting
1 parent 0c763b6 commit ba74c72

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

docs/docs/features/breaking-change-analysis.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,27 @@ title: Breaking Change Analysis
33
icon: octicons/diff-modified-24
44
---
55

6-
**Breaking Change Analysis** examines modified models and categorizes changes into three types: **Breaking change**, **Partial breaking change**, and **Non breaking change**.
6+
**Breaking Change Analysis** examines modified models and categorizes changes into three types:
77

8-
Traditionally, any modification to a model’s SQL was assumed to affect all downstream models. However, not all changes have the same level of impact. For example, formatting adjustments or adding a new column should not break any downstream dependencies. **Breaking Change Analysis** helps you assess whether a change affects downstream models, and if so, to what extent.
8+
- Breaking changes
9+
- Partial breaking changes
10+
- Non-breaking changes
911

12+
It's generally assumed that any modification to a model’s SQL will affect all downstream models. However, not all changes have the same level of impact. For example, formatting adjustments or the addition of a new column should not break downstream dependencies. Breaking change analysis helps you assess whether a change affects downstream models and, if so, to what extent.
1013

11-
## Categories
14+
15+
## Categories of change
1216
Category | Downstream Impact | Examples
1317
---|---|---
14-
Non breaking change | No downstream models are affected | Adding a new column, formatting SQL, adding comments
18+
Non-breaking change | No downstream models are affected | New column, formatting SQL, adding comments
1519
Partial breaking change | Only downstream models referencing certain columns are affected | Removing, renaming, or modifying the definition of a column
1620
Breaking change | All downstream models are affected | Changing filter conditions (e.g. `WHERE`), sort order (`ORDER BY`), or other SQL logic
1721

1822
## Usage
1923

20-
To enable the feature, click the **Breaking Change Analysis** toggle on the **Lineage** page.
24+
To enable **Breaking Change Analysis**, click the toggle on the **Lineage** page.
2125

22-
All modified models will display their change category directly on the node. Additionally, partial breaking changes are highlighted with a dashed orange border to indicate that they may not impact your downstream models.
26+
All modified models display their change category directly on the node. Additionally, partial breaking changes are highlighted with a dashed orange border to indicate that they may not impact downstream models.
2327

2428
=== "Disabled"
2529

@@ -32,7 +36,7 @@ All modified models will display their change category directly on the node. Add
3236

3337
## Column-Level Lineage
3438

35-
In models classified as **Non breaking** or **Partial breaking**, added, removed, or modified columns will be listed. You can click on a column to open its [Column-Level Lineage](./column-level-lineage.md)
39+
In models classified as **non-breaking** or **partial breaking** - added, removed, or modified columns will be listed. Click on a column to open its [Column-Level Lineage](./column-level-lineage.md)
3640

3741
![Column-level lineage](../../assets/images/features/breaking-change-lineage.png){: .shadow}
3842

0 commit comments

Comments
 (0)