Repository navigation
docs: fix documentation inconsistencies with the application - #524
Merged
Merged
Conversation
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
This was referenced Nov 11, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
{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.metadata.jsonkeys; DataLab-Kernel usage.SimpleRemoteProxy; complete list of the supported methods.# DataLab template:title line,~/.DataLab_v1/macro_templates,Conf.macro_*options, recovery file.dst_1_to_1,sigima.io.read_*/write_*, noise example.pytest --pyargs sigima -m validation; log files location.datalab.web_pluginsentry-point group,asynccallbacks and*_asynchelpers 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.datalab,[qt]and[opencv]extras,developbranch 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).macros/examples/simple_macro.py,doc/remotecontrol_py27.py, remote examples and notebooks, plugin examples.sphinx_intl update -w 0).Validation
-Wwithout warning; gettext extraction andsphinx_intl updateafter rebasing ondevelopleave the catalogs unchanged; docutils check of the changed pages (the build hides docutils warnings, see Documentation build hides reStructuredText syntax errors #521); Ruff clean on the 16 changed Python files; plugin example tests and macro tests passed; changed examples compiled; formats and menus checked against the registries and the regenerated menus.Out of scope
[webapi]extra that does not exist.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