We are now at v2.1. The docstrings still contain references to div issues and statements on why/how it was changed from v1.
See for example this API (docstring) for Batch:
batch ¶
cellpy.batch -- the batch v3 subsystem (#696).
A boring, standard architecture for batch processing, which replaced the utils/batch_tools "farm/barn" machinery (removed in 2.1, E4 #716); cellpy.utils.batch is a thin re-export/shim.
Modules land incrementally (plan sections 4 & 6): journal -- Journal model + json readers/writers (#698, this arc) layout -- BatchPaths: pure path computation + ensure_dirs (#698) policy -- LoadPolicy / CellSpec typed options (#699) runner -- load_cell / run -> BatchResult (#700) ...
Readers do not need to know what it used to be and in what issue the changes were handled in. References to issues could be left in the code, but only as comments, not in the actual docstring.
We are now at v2.1. The docstrings still contain references to div issues and statements on why/how it was changed from v1.
See for example this API (docstring) for Batch:
batch ¶
Readers do not need to know what it used to be and in what issue the changes were handled in. References to issues could be left in the code, but only as comments, not in the actual docstring.