Skip to content

Commit 70b2566

Browse files
authored
more doc cleanup (#569)
1 parent 6f075ca commit 70b2566

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

docs/branching.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -128,10 +128,10 @@ and executes them.
128128
### Branching Limitations
129129

130130
Most of branching's limitations are around:
131+
131132
- [using a branch to manipulate another](#branch-interactions)
132133
- [shared SDF state](#using-with-state)
133134

134-
135135
## Branching Example
136136

137137
In this example, we have purchase events similar to our [purchase-filtering tutorial](tutorials/purchase-filtering/tutorial.md):
@@ -248,7 +248,7 @@ Processing the [example value](#example-value) would produce 2 values in the fol
248248
- `"Congratulations Jane Doe, your recent purchase totaling $212.36 was enough to earn you a coupon!"`
249249

250250

251-
# Execution Ordering
251+
## Execution Ordering
252252

253253
Because of the way branches are tracked and interact, ordering can be tricky.
254254

@@ -259,7 +259,7 @@ That said, if you have behavior that relies on a specific execution ordering,
259259
it is recommended to test it and ensure its occurring in the order you expect, as
260260
there may be uncaught edge cases.
261261

262-
## Ordering Example
262+
### Ordering Example
263263

264264
```python
265265
from quixstreams import Application
@@ -308,7 +308,7 @@ SDF
308308
└── (+ 500 ) = 530
309309
```
310310

311-
## Ordering with `expand=True`
311+
### Ordering with `expand=True`
312312

313313
Using `expand=True` (like with `SDF.apply(f, expand=True)`) also produces its results
314314
in a specific order: each element of the expand is fully processed before handling the
@@ -426,8 +426,10 @@ are much cheaper relative to the first).
426426
Some considerations for mitigating loss in performance due to cloning:
427427

428428
Before (or while) creating a branch:
429+
429430
1. Reduce the value size (ex: use column projection)
430431
- Smaller value = lower clone cost
432+
431433
2. Filter values upfront
432434
- lower data volume = less data to clone
433435

0 commit comments

Comments
 (0)