Small Tweaks

[sanbales]

References

Small miscellaneous tweaks, trying to address some of the issues in #63.

Code changes

• Add hyperbolic functions (cosh, sinh, tanh) and an n-dimensional hypothenuse (hypot) to the templating engine.
• Add tables and explanations to the Behaviors.ipynb for the jsMath functions available when using the Nunjucks template.
• Add a check for Selection behaviors to show up before others, throws a warning if they are not first.
  • Add test
• Preserve LinkShape.curvature and LinkShape.line_dash between selected and unselected links by default, e.g., set LinkSelection.selected_curvature = None and update the ts to behave appropriately.
• Fix label for link arrows and link particles controls in Behaviors.ipynb (part of Documentation items for 0.3.2 #63)
• Improve Shapes.ipynb
  • Add color scales
  • Finish demo controls (part of Documentation items for 0.3.2 #63)
• Adding --fix flag to ruff to fix python code, e.g., auto-sort imports as isort used to do

User-facing changes

• adds more mathematical functions available when using the Nunjucks template (cosh, sinh, tanh, and hypot)
  • adds better explanation for the functions and constants in the Behaviors notebook
• adds a warning if node or link behaviors are included in an order that can cause unexpected issues
• adds automatic UI controls for NodeShapes in the Shapes and Behaviors notebooks
  

Backwards-incompatible changes

No backwards incompatible changes.

[sanbales]

Adding some hacky controls for NodeShapes, but still needs more work

[sanbales]

Adding some hacky controls for NodeShapes, but still needs more work

Fixed in eec4fb2

[nrbgt]

The extended templating content is good, but long, and buried.

Maybe we move it to one of:

• a dedicated notebook, with in-links from various places
  • and/or include this content in the docs
  • potentially with a more full demo, not attached to a renderer
• a dedicated .md, so that it is searchable within the docs
• in-line in the docstring of the python Nunjucks class itself
• in-line in the text of the TypeScript class and start building typescript

Each of the above have various drawbacks from a maintenance perspective, of course.

[nrbgt]

yerp, rather than adding this business, would see adding a rank to the behaviors, which get sorted (ha) out on the frontend, with some sensible defaults... warnings and complex validation methods can still get swallowed when things are done "live,"

[sanbales]

Made an issue #76, unless we want to fix it in this PR

[nrbgt]

Local tests and docs look fine: leave it up to @sanbales if we want to handle the template docs "debt" and/or complexity debt of the behavior order on this PR or on a follow-up... as this doesn't map to something directly shippable, no reason not to do it here, would be my feeling.

[nrbgt]

Looks fine, aside from the called-out docs and rank choices.

[sanbales]

The extended templating content is good, but long, and buried.

Maybe we move it to one of:

* a dedicated notebook, with in-links from various places
  
  * and/or include this content in the docs
  * potentially with a more full demo, _not_ attached to a renderer

* a dedicated `.md`, so that it is searchable within the docs

* in-line in the docstring of the python `Nunjucks` class itself

* in-line in the text of the TypeScript class and start building typescript

Each of the above have various drawbacks from a maintenance perspective, of course.

I can see all of these being useful, if I had to chose one, I'd say we have a dedicated notebook with good explanations, and have it rendered in the docs as a reference html in case (for whatever reason) folks don't/can't run lite, effectively producing that .md. Not sure if nbsphinx is a good idea or not, so I'd defer to y'all on this.

I did add more docs to the Nunjucks class, but those super long (e.g., numpy DOCSTRINGs) can be a bit of a pain if they are just a bunch of different long examples... It's great to have 2 or 3 pithy examples in the DOCSTRING that span the range of possibilities.

[sanbales]

The extended templating content is good, but long, and buried.

Maybe we move it to one of:

* a dedicated notebook, with in-links from various places
  
  * and/or include this content in the docs
  * potentially with a more full demo, _not_ attached to a renderer

* a dedicated `.md`, so that it is searchable within the docs

* in-line in the docstring of the python `Nunjucks` class itself

* in-line in the text of the TypeScript class and start building typescript

Each of the above have various drawbacks from a maintenance perspective, of course.

Created an issue to track this.