G
YouTube TikTok Games
Skip to content

docs: fix documentation inconsistencies with the application - #524

Merged
PierreRaybaut merged 1 commit into
developfrom
docs/519-documentation-audit
Nov 11, 2026
Merged

PierreRaybaut merged 1 commit into
developfrom
docs/519-documentation-audit

Conversation

@PierreRaybaut

Copy link
Copy Markdown
Contributor

Closes #519

Summary

A systematic comparison of the documentation of DataLab 1.4 with the application (and with the documentation of Sigima, SigimaX and DataLab-Web) found about 140 wrong or outdated statements. Some of them misled users (Web API security default, remote control from another computer, wrong formulas) or broke examples and commands (conda install datalab-platform, simple_macro.py, remotecontrol_py27.py, migration table names).

Changes

  • Signal and image features: menu placement and exact labels, arithmetic operation, quadratic difference and amplitude normalization formulas, unsupported {zlabel}/{zunit} placeholders removed, contour and 2D peak detection result columns, annotations stored apart from metadata, file format tables generated from the Sigima registries, zero padding and frequency filters, missing entries (Web API, Quit, panels), validation pages (naming rules, test counts) and regenerated validation status files.
  • Common features: the Processing tab recomputes the object in place (no History edit mode anymore), settings options and their default values (new options, restart required, AI Assistant, external editor), overview example, HDF5 browser commands, key features and introduction, DataLab-Capsule in the ecosystem pages, results equal "exactly or within the tolerance of the operation contract" across editions.
  • Tutorials: menu paths and labels (File > Settings..., Analysis > Intensity profiles > Line profile..., Processing > Fitting > Interactive fitting > Multi-Gaussian fit...), plugin configuration and reload, data file names, removed Results button and annotation workflow; figures showing something else than described are removed (screenshots are refreshed in Outdated screenshots in tutorials and feature pages #520).
  • Advanced features:
    • Web API: the localhost token bypass is enabled by default, with how to disable it and the security warning updated; NPZ metadata.json keys; DataLab-Kernel usage.
    • Remote control: limited to the local machine; methods missing from SimpleRemoteProxy; complete list of the supported methods.
    • Macros: no regular expressions, # DataLab template: title line, ~/.DataLab_v1/macro_templates, Conf.macro_* options, recovery file.
    • Migration table: dst_1_to_1, sigima.io.read_*/write_*, noise example.
    • Validation tests run with pytest --pyargs sigima -m validation; log files location.
  • Plugins: DataLab-Web compatibility (distinct class in the datalab.web_plugins entry-point group, async callbacks and *_async helpers Web-only, Desktop features not supported in the browser, Plugin shim: support the Desktop registration model (register_computations, action_for) web#94), public API page (PluginCapability, recipe_binding, resources...), examples with correct helper signatures and selection conditions, catalog rules, test templates README.
  • Installation and contributing: conda-forge package datalab, [qt] and [opencv] extras, develop branch for the development version, file names, WiX commands, line length and VS Code task names, branch names, roadmap and outreach facts, .github/copilot-instructions.md (action handler pattern, including the redefinition of a reopened built-in submenu, configuration package, plugin folder, contract versions of Sigima 1.4).
  • Examples: macros/examples/simple_macro.py, doc/remotecontrol_py27.py, remote examples and notebooks, plugin examples.
  • Docstrings rendered in the API pages (no behavior change).
  • Release notes (Documentation since 1.4.0) and French translation of all the changed pages (56 catalogs; 9 of them were stored with wrapped lines and are now unwrapped, as produced by sphinx_intl update -w 0).

Validation

Out of scope

Related: #523 (code fixes found by the same review), DataLab-Platform/Sigima#124, DataLab-Platform/SigimaX#73, DataLab-Platform/web#95, DataLab-Platform/plugins#13

Assisted-by: Claude Opus 5.5

A systematic comparison of the documentation with the application
(DataLab 1.4) found about 140 wrong or outdated statements, some of
which misled users or broke examples.

- Signal and image features: menu placement and labels, formulas
  (arithmetic, quadratic difference, amplitude normalization), file
  name placeholders, contour and peak detection results, annotations
  stored apart from metadata, file formats generated from the
  registries, zero padding, frequency filters, validation pages and
  regenerated validation status
- Common features: Processing tab and History (no edit mode anymore),
  settings options and default values, overview example, HDF5 browser
  commands, key features and introduction, DataLab-Capsule in the
  ecosystem, results equal within the contract tolerance
- Tutorials: menu paths and labels, plugin configuration and reload,
  data file names, removed Results button, figures showing something
  else removed (screenshots tracked by #520)
- Advanced features: Web API localhost bypass enabled by default and
  how to disable it, NPZ metadata, DataLab-Kernel usage, remote control
  limited to the local machine, supported remote methods, macros
  (templates, configuration, recovery file), migration table names,
  validation tests, configuration folder `~/.DataLab_v1`
- Plugins: DataLab-Web compatibility (`datalab.web_plugins`, no async
  callbacks on Desktop, unsupported Desktop features, web#94), public
  API, examples with correct helper signatures, catalog rules
- Installation and contributing: conda-forge package `datalab`, `[qt]`
  and `[opencv]` extras, `develop` branch, file names, WiX commands,
  line length and VS Code tasks, branch names, roadmap and outreach,
  `.github/copilot-instructions.md`
- Broken examples: `simple_macro.py`, `remotecontrol_py27.py`, remote
  examples and notebooks
- Docstrings rendered in the API pages (no behavior change)
- Release notes and French translation

Closes #519

Assisted-by: Claude Opus 5.5
@PierreRaybaut PierreRaybaut added this to the v1.4.1 milestone Nov 11, 2026
@PierreRaybaut PierreRaybaut added the documentation Improvements or additions to documentation label Nov 11, 2026
@PierreRaybaut
PierreRaybaut merged commit 0b8d080 into develop Nov 11, 2026
6 checks passed
@PierreRaybaut
PierreRaybaut deleted the docs/519-documentation-audit branch November 11, 2026 08:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant