Skip to content

simplecadapi 2.2.6.post2

Choose a tag to compare

@NiJingzhe NiJingzhe released this 20 Oct 17:32
· 79 commits to master since this release
9e749ed

2.2.6.post2 Update Notes

No change in what the SDK computes. Eight operators moved to the module of their family, and
the API reference they are documented in is now generated for all of them.

Operators live with their family

operator now in
scale_rsolid, transform_rsolid operators/transform.py (next to translate_shape, rotate_shape)
boolean_rsolidlist operators/boolean.py (next to union_rsolid, cut_rsolid)
offset_rsolid, draft_rsolid, extrude_taper_rsolid, extrude_until_rsolid, sweep_multisection_rsolid operators/features.py (next to extrude_rsolid, shell_rsolid, sweep_rsolid)

from simplecadapi import scale_rsolid (and every other name) works as before. Code that
imported them from the modules they were first written in, simplecadapi.operators.deformation,
draft, section_features or limited_extrusion, still works and gets a DeprecationWarning
naming the new place; import from simplecadapi instead.

The API reference is generated for every operator

The documentation generator kept its own hand-written list of source files and public
functions, and nobody had added those four modules to it. The docs of the eight operators above
were therefore written by hand, and the generator deleted them whenever it ran, while
boolean_rsolidlist had none. Now operators/ is discovered, a function the package exports is
public, and what the hand-written docs said (examples, error conditions, how the operation is
replayed) is in the docstrings, so it is in the generated docs. Tests fail if a public operator
has no doc, or if the committed docs differ from what the generator writes.