Skip to content

Commit 5a3a8cd

Browse files
committed
docs: link to schemas from transform docs
1 parent 9d76ee8 commit 5a3a8cd

File tree

4 files changed

+23
-0
lines changed

4 files changed

+23
-0
lines changed

docs/reference/transforms/chunking.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,12 @@ The :mod:`taskgraph.transforms.chunking` module contains transforms that aid
77
in splitting a single entry in a ``kind`` into multiple tasks. This is often
88
used to parallelize expensive or slow work.
99

10+
Schema
11+
------
12+
13+
All tasks must conform to the :py:data:`chunking schema
14+
<taskgraph.transforms.chunking.CHUNK_SCHEMA>`.
15+
1016
Usage
1117
-----
1218

docs/reference/transforms/from_deps.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,11 @@ These transforms are useful when you want to create follow-up tasks for some
1111
indeterminate subset of existing tasks. For example, maybe you want to run
1212
a signing task after each build task.
1313

14+
Schema
15+
------
16+
17+
All tasks must conform to the :py:data:`from_deps schema
18+
<taskgraph.transforms.from_deps.FROM_DEPS_SCHEMA>`.
1419

1520
Usage
1621
-----

docs/reference/transforms/matrix.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,12 @@ task into many subtasks based on a defined matrix.
99
These transforms are useful if you need to have many tasks that are very
1010
similar except for some small configuration differences.
1111

12+
Schema
13+
------
14+
15+
All tasks must conform to the :py:data:`matrix schema
16+
<taskgraph.transforms.matrix.MATRIX_SCHEMA>`.
17+
1218
Usage
1319
-----
1420

docs/reference/transforms/task_context.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,12 @@ until ``taskgraph`` runs.
99

1010
This data can be provided in a few ways, as described below.
1111

12+
Schema
13+
------
14+
15+
All tasks must conform to the :py:data:`task_context schema
16+
<taskgraph.transforms.task_context.SCHEMA>`.
17+
1218
Usage
1319
-----
1420

0 commit comments

Comments
 (0)