docs: README, version metadata and UI text disagree with the code #62

Open
opened 2026-10-06 13:55:18 +00:00 by ffrauenberger · 1 comment
Owner

Severity: improvement (low)

Where

  • README.md
  • pyproject.toml:7
  • package.nix:44
  • app/ui/home_ui/home_view.py:49-60, :91

Problem

  • Model import: the README says "Load ProcessIntel native process models", and the home page mentions exporting "your workspace". Importing is not possible: .pickle is not an accepted upload type (and should not become one, see #32).
  • Inputs: the README lists only CSV event logs, although XES import and a CSV↔XES converter exist.
  • Algorithms: the README lists five miners; Inductive Mining Infrequent is missing.
  • Version: README 1.0.0, pyproject.toml 1.0, package.nix v1: three different strings for one release.
  • Maturity claim: "Stability: Ready for productive use", while known bugs (e.g. #1, #4) affect core results.
  • UI typo: the select box label on the home page reads "Mining Algorthm".
  • The README test command skips a test file (#56).

Related: #32, #56.

Fix

  • Single-source the version (e.g. importlib.metadata.version("processintel"), Nix version read from pyproject.toml)
  • Update the feature list, supported inputs, algorithm list and maturity statement to match the code
  • Fix the UI typo and the test command

from issues/DOC-001-readme-and-metadata-inconsistent-with-code.md (code analysis of commit 6bcc646, 2026-10-03)

**Severity:** improvement (low) ## Where - `README.md` - `pyproject.toml:7` - `package.nix:44` - `app/ui/home_ui/home_view.py:49-60`, `:91` ## Problem - **Model import:** the README says *"Load ProcessIntel native process models"*, and the home page mentions exporting *"your workspace"*. Importing is not possible: `.pickle` is not an accepted upload type (and should not become one, see #32). - **Inputs:** the README lists only *CSV event logs*, although XES import and a CSV↔XES converter exist. - **Algorithms:** the README lists five miners; *Inductive Mining Infrequent* is missing. - **Version:** README `1.0.0`, `pyproject.toml` `1.0`, `package.nix` `v1`: three different strings for one release. - **Maturity claim:** *"Stability: Ready for productive use"*, while known bugs (e.g. #1, #4) affect core results. - **UI typo:** the select box label on the home page reads *"Mining Algorthm"*. - The README test command skips a test file (#56). Related: #32, #56. ## Fix - Single-source the version (e.g. `importlib.metadata.version("processintel")`, Nix `version` read from `pyproject.toml`) - Update the feature list, supported inputs, algorithm list and maturity statement to match the code - Fix the UI typo and the test command --- from `issues/DOC-001-readme-and-metadata-inconsistent-with-code.md` (code analysis of commit 6bcc646, 2026-10-03)
Author
Owner

Reviewed by Codex (GPT-6) against origin/main 6bcc646eb464.

Review: partially correct.

The README input/algorithm/import discrepancies are supported. Two details need qualification. The Mining Algorthm typo is in display_model_import() (home_view.py:79–98), called only by the currently unreachable pickle-import branch, so it is not a label users encounter in the present CSV/XES home flow. It is still a code typo worth fixing.

Also, 1.0 and 1.0.0 are equivalent Python release-version spellings, so differing strings alone do not establish differing releases. Nix's v1 is a separate presentation string. Single-sourcing version metadata remains useful; avoid implying three incompatible release versions merely from these spellings.

Code references: app/ui/home_ui/home_view.py:79, app/ui/home_ui/home_controller.py:93, pyproject.toml:7.

Reviewed by **Codex (GPT-6)** against origin/main [`6bcc646eb464`](https://code.swisdata.eu/ffrauenberger/ProcessIntel/commit/6bcc646eb464e0dd897228b5e49867f65d7255c4). **Review: partially correct.** The README input/algorithm/import discrepancies are supported. Two details need qualification. The `Mining Algorthm` typo is in `display_model_import()` (home_view.py:79–98), called only by the currently unreachable pickle-import branch, so it is not a label users encounter in the present CSV/XES home flow. It is still a code typo worth fixing. Also, `1.0` and `1.0.0` are equivalent Python release-version spellings, so differing strings alone do not establish differing releases. Nix's `v1` is a separate presentation string. Single-sourcing version metadata remains useful; avoid implying three incompatible release versions merely from these spellings. Code references: [app/ui/home_ui/home_view.py:79](https://code.swisdata.eu/ffrauenberger/ProcessIntel/src/commit/6bcc646eb464e0dd897228b5e49867f65d7255c4/app/ui/home_ui/home_view.py#L79), [app/ui/home_ui/home_controller.py:93](https://code.swisdata.eu/ffrauenberger/ProcessIntel/src/commit/6bcc646eb464e0dd897228b5e49867f65d7255c4/app/ui/home_ui/home_controller.py#L93), [pyproject.toml:7](https://code.swisdata.eu/ffrauenberger/ProcessIntel/src/commit/6bcc646eb464e0dd897228b5e49867f65d7255c4/pyproject.toml#L7).
Sign in to join this conversation.
No milestone
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
ffrauenberger/ProcessIntel#62
No description provided.