Skip to content

Commit bec2463

Browse files
committed
DOC(changes): add contents at the top, fill-in titles
1 parent 16189fe commit bec2463

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

CHANGES.rst

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
Graphtik Changelog
33
##################
44

5+
.. contents::
6+
57
..
68
TODOs
79
%%%%%
@@ -199,8 +201,8 @@ v7.1.0 (4 May 2020, @ankostis): Cancelable sideffects, theme-ize & expand everyt
199201
Should have been a MAJOR BUMP due to breaking renames, but just out of
200202
another 6.x --> 7.x major bump.
201203

202-
NET
203-
---
204+
NET: fix rescheduled, cancelable sfx, improve compute API
205+
---------------------------------------------------------
204206
+ FIX: rescheduled operations were not canceling all downstream deps & operations.
205207
+ FEAT: Cancelable sideffects: a :term:`reschedule`\s operation may return
206208
a "falsy" sideffect to cancel downstream operations.
@@ -212,16 +214,16 @@ NET
212214
to ``compute()`` - to quickly experiment with function, access it from the
213215
operation's :attr:`.FunctionalOperation.fn` attribute
214216

215-
MODIFIERS
216-
---------
217+
MODIFIERS: modifier combinations, rename sol_sideffects
218+
-------------------------------------------------------
217219
+ BREAK: renamed modifiers ``sol_sideffect --> sideffected``, to reduce terminology
218220
mental load for the users.
219221
+ ENH: support combinations of modifiers (e.g. optional sideffects).
220222
+ REFACT: convert modifiers classes --> factory functions, producing :class:`._Modifier`
221223
instances (normally not managed by the user).
222224

223-
PLOT
224-
----
225+
PLOT: them-ize all, convey user-attrs, draw nest clusters, click SVGs to open in tab, ...
226+
-----------------------------------------------------------------------------------------
225227
+ ENH: Theme-ize all; expand callables (beyond Refs and templates).
226228
+ BREAK: rename ``Theme.with_set()`` --> :meth:`.Theme.withset()`.
227229
+ break: pass verbatim any `nx-attrs` starting with ``'graphviz.'`` into
@@ -238,8 +240,8 @@ PLOT
238240
+ fix(sphinxext): don't choke on duplicate ``:name:`` in :rst:dir:`graphtik` directives.
239241
+ fix(sphinxext): fix deprecation of sphinx ``add_object()`` with ``note_object()``.
240242

241-
Various
242-
-------
243+
Various: raise TypeErrors, improve "operations" section
244+
-------------------------------------------------------
243245
+ break: raise ``TypeError`` instead of ``ValueError`` wherever it must.
244246
+ DOC(operations): heavily restructured chapter - now might stand alone.
245247
Started using the `pipeline` name more often.
@@ -276,8 +278,8 @@ v7.0.0 (28 Apr 2020, @ankostis): In-solution sideffects, unified OpBuilder, plot
276278

277279
+ DROP(NET): ``_DataNode`` and use str + modifier-classes as data-nodes;
278280

279-
MODIFIERS:
280-
----------
281+
MODIFIERS: Sideffecteds; arg--> mapped
282+
---------------------------------------
281283
+ BREAK: rename `arg --> mapped``, which conveys the correct meaning.
282284

283285
+ FEAT: Introduced :term`sideffected`\s, to allow for certain dependencies
@@ -289,8 +291,8 @@ MODIFIERS:
289291
graph.
290292
+ FEAT(op): print detailed deps when DEBUG enabled.
291293

292-
PLOT:
293-
-----
294+
PLOT: Badges, StyleStacks, refact Themes, fix style mis-classifications, don't plot steps
295+
-----------------------------------------------------------------------------------------
294296
+ ENH: recursively merge Graphviz-styles attributes, with expanding jinja2-template
295297
and extending lists while preserving theme-provenance, for debugging.
296298

0 commit comments

Comments
 (0)