Skip to content

Commit 51a1a62

Browse files
committed
doc(quick+ops) math-ref sample formula
1 parent ed55ab8 commit 51a1a62

File tree

3 files changed

+7
-6
lines changed

3 files changed

+7
-6
lines changed

docs/source/index.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,10 +79,11 @@ separately with your OS tools)::
7979
pip install graphtik[plot]
8080

8181

82-
Let's build a *graphtik* computation :term:`pipeline` that produces x3 :term:`outputs`
83-
out of 2 :term:`inputs` `a` and `b`:
82+
Let's build a *graphtik* computation :term:`pipeline` that produces the following
83+
x3 :term:`outputs` out of x2 :term:`inputs` (`a` and `b`):
8484

8585
.. math::
86+
:label: sample-formula
8687
8788
a \times b
8889

docs/source/operations.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -231,8 +231,8 @@ Considerations for when building pipelines
231231
------------------------------------------
232232
When many operations are composed into a computation graph, Graphtik matches up
233233
the values in their *needs* and *provides* to form the edges of that graph
234-
(see :ref:`graph-composition` for more on that), like the operations from the script
235-
in :ref:`quick-start`:
234+
(see :ref:`graph-composition` for more on that), like the operations from
235+
the sample formula :eq:`sample-formula` in :ref:`quick-start` section:
236236

237237
>>> from operator import mul, sub
238238
>>> from functools import partial

docs/source/pipelines.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ instances into a runnable computation graph.
88

99
The simplest use case is to assemble a collection of individual operations
1010
into a runnable computation graph.
11-
The example script from :ref:`quick-start` illustrates this well:
11+
The sample formula :eq:`sample-formula` from :ref:`quick-start` section illustrates this well:
1212

1313
>>> from operator import mul, sub
1414
>>> from functools import partial
@@ -34,7 +34,7 @@ The call here to ``compose()`` yields a runnable computation graph that looks li
3434
This yields a graph which looks like this (see :ref:`plotting`):
3535

3636
.. graphtik::
37-
:name: formula
37+
:name: sample formula :eq:`sample-formula`
3838

3939
>>> formula.plot('calc_power.svg') # doctest: +SKIP
4040

0 commit comments

Comments
 (0)