Skip to content

Conversation

MichaelBuessemeyer
Copy link
Contributor

@MichaelBuessemeyer MichaelBuessemeyer commented Sep 23, 2025

This PR fixes all spellings of "super-voxel" or "Super-voxel" and removes their - to match the correct spelling according to https://en.wiktionary.org/wiki/supervoxel.

URL of deployed dev instance (used for testing):

  • https://___.webknossos.xyz

Steps to test:

  • not needed

Issues:


(Please delete unneeded items, merge only when none are left open)

  • Added changelog entry (create a $PR_NUMBER.md file in unreleased_changes or use ./tools/create-changelog-entry.py)
  • Updated documentation if applicable

Copy link
Contributor

coderabbitai bot commented Sep 23, 2025

📝 Walkthrough

Walkthrough

Terminology standardized from “super-voxel” to “supervoxel” across docs, UI labels, and comments. Minor punctuation and capitalization tweaks applied. Added an unreleased change note. No functional logic or public APIs were modified.

Changes

Cohort / File(s) Summary of changes
Docs terminology standardization
docs/proofreading/index.md, docs/proofreading/proofreading_tool.md, docs/terminology.md, docs/volume_annotation/tools.md
Replace “super-voxel” with “supervoxel”; minor numbering/newline fix; small punctuation tweak.
Frontend UI labels
frontend/javascripts/viewer/controller/combinations/tool_controls.ts, frontend/javascripts/viewer/view/context_menu.tsx
Update user-facing strings: capitalization (“Jump to Point”, “Activate Supervoxel”) and label (“Supervoxel” → “Supervoxel”/“Supervoxel” standardized to “Supervoxel” display as “Supervoxel”).
Frontend comments cleanup
frontend/javascripts/viewer/model/sagas/volume/proofread_saga.ts, frontend/javascripts/viewer/view/plane_view.ts, frontend/javascripts/viewer/shaders/segmentation.glsl.ts
Comments updated to use “supervoxel”; no logic changes.
Changelog entry
unreleased_changes/8952.md
Add unreleased note documenting the terminology spelling fix.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • Update Documentation #8262 — Documentation updates touching proofreading and volume-annotation docs; likely related to the same terminology/ docs changes.

Suggested labels

frontend

Suggested reviewers

  • philippotto

Poem

I thump my paws with tidy zeal,
From hyphen hills to voxel fields I wheel.
Supervoxel sings, both sleek and bright,
Carrot-checks gleam in morning light. 🥕✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The title “Fix supervoxel spelling” directly and succinctly summarizes the core change of removing hyphens from “super-voxel” across the codebase, making it clear and specific for any reviewer scanning the history.
Description Check ✅ Passed The description clearly states that the PR standardizes “super-voxel” to “supervoxel,” cites the source for the correct spelling, and includes relevant links and a completed checklist, ensuring it is directly related to the changes in the pull request.
✨ Finishing touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch supervoxel-naming

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0b05153 and e5d71d8.

📒 Files selected for processing (1)
  • frontend/javascripts/viewer/view/context_menu.tsx (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • frontend/javascripts/viewer/view/context_menu.tsx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: frontend-tests
  • GitHub Check: build-smoketest-push
  • GitHub Check: backend-tests

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
docs/proofreading/proofreading_tool.md (1)

8-8: Grammar: fix comma placement

Remove the comma after “Once” and add one after “this”.

Apply this diff:

-To use the proofreading tool you need to enable an [ID mapping for your segmentation](./segmentation_mappings.md) to load the supervoxel graph. Once, WEBKNOSSOS detects this the proofreading tool can be activated on the toolbar (clipboard icon):
+To use the proofreading tool, you need to enable an [ID mapping for your segmentation](./segmentation_mappings.md) to load the supervoxel graph. Once WEBKNOSSOS detects this, the proofreading tool can be activated on the toolbar (clipboard icon):
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3a9cd8a and 0b05153.

📒 Files selected for processing (10)
  • docs/proofreading/index.md (1 hunks)
  • docs/proofreading/proofreading_tool.md (2 hunks)
  • docs/terminology.md (1 hunks)
  • docs/volume_annotation/tools.md (1 hunks)
  • frontend/javascripts/viewer/controller/combinations/tool_controls.ts (1 hunks)
  • frontend/javascripts/viewer/model/sagas/volume/proofread_saga.ts (3 hunks)
  • frontend/javascripts/viewer/shaders/segmentation.glsl.ts (1 hunks)
  • frontend/javascripts/viewer/view/context_menu.tsx (2 hunks)
  • frontend/javascripts/viewer/view/plane_view.ts (1 hunks)
  • unreleased_changes/8952.md (1 hunks)
🧰 Additional context used
🧠 Learnings (4)
📚 Learning: 2025-09-08T13:33:47.097Z
Learnt from: MichaelBuessemeyer
PR: scalableminds/webknossos#8824
File: frontend/javascripts/viewer/view/context_menu.tsx:1033-1039
Timestamp: 2025-09-08T13:33:47.097Z
Learning: In frontend/javascripts/viewer/view/context_menu.tsx, the segmentIdLabel intentionally shows the unmapped segment ID (maybeUnmappedSegmentId) in the "within Segment ${id}" text when proofreading is active, as this can be helpful for users. The mapped segment ID (segmentIdAtPosition) is only used as a fallback when the unmapped ID is not available.

Applied to files:

  • frontend/javascripts/viewer/view/context_menu.tsx
  • frontend/javascripts/viewer/shaders/segmentation.glsl.ts
  • frontend/javascripts/viewer/view/plane_view.ts
  • frontend/javascripts/viewer/model/sagas/volume/proofread_saga.ts
📚 Learning: 2024-12-12T12:53:07.439Z
Learnt from: hotzenklotz
PR: scalableminds/webknossos#8262
File: docs/volume_annotation/tools.md:31-35
Timestamp: 2024-12-12T12:53:07.439Z
Learning: In `docs/volume_annotation/tools.md`, the SAM2 model used in the Quick Select tool predicts on several layers at once and is capable of understanding image sequences. The AI mode processes multiple layers at a time.

Applied to files:

  • docs/volume_annotation/tools.md
📚 Learning: 2024-11-22T17:18:43.411Z
Learnt from: dieknolle3333
PR: scalableminds/webknossos#8168
File: frontend/javascripts/oxalis/geometries/materials/plane_material_factory.ts:568-585
Timestamp: 2024-11-22T17:18:43.411Z
Learning: In the file `frontend/javascripts/oxalis/geometries/materials/plane_material_factory.ts`, the uniform name `allResolutions` should remain unchanged to maintain consistency with the shader code.

Applied to files:

  • frontend/javascripts/viewer/view/plane_view.ts
📚 Learning: 2024-11-22T17:18:04.217Z
Learnt from: dieknolle3333
PR: scalableminds/webknossos#8168
File: frontend/javascripts/oxalis/model/sagas/proofread_saga.ts:1039-1039
Timestamp: 2024-11-22T17:18:04.217Z
Learning: In `frontend/javascripts/oxalis/model/sagas/proofread_saga.ts`, when calling `getMagInfo`, the use of `volumeTracingLayer.resolutions` is intentional and should not be changed to `volumeTracingLayer.mags`.

Applied to files:

  • frontend/javascripts/viewer/model/sagas/volume/proofread_saga.ts
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: build-smoketest-push
  • GitHub Check: backend-tests
🔇 Additional comments (17)
docs/terminology.md (1)

49-49: LGTM - Terminology standardization completed.

The change from "super-voxel graph" to "supervoxel graph" aligns with the PR objectives and the Wiktionary reference provided. This consistent terminology update improves documentation clarity.

unreleased_changes/8952.md (1)

1-2: LGTM - Appropriate changelog entry.

The changelog entry accurately documents the spelling fix from "super-voxel" to "supervoxel" which matches the PR's scope and objectives.

docs/volume_annotation/tools.md (1)

38-38: LGTM - Consistent terminology update.

The change from "super-voxel graph" to "supervoxel graph" maintains consistency with the broader terminology standardization effort across the codebase.

docs/proofreading/index.md (1)

7-7: LGTM - Documentation consistency maintained.

The terminology update from "super-voxel graph" to "supervoxel graph" aligns with the project-wide standardization and maintains consistency across proofreading documentation.

frontend/javascripts/viewer/controller/combinations/tool_controls.ts (1)

1134-1136: LGTM - UI text improvements and terminology standardization.

The changes serve dual purposes:

  1. Capitalization improvement: "Jump to point" → "Jump to Point"
  2. Terminology standardization: "Activate super-voxel" → "Activate Supervoxel"

Both changes enhance the user interface consistency and align with the project-wide terminology updates.

frontend/javascripts/viewer/view/plane_view.ts (1)

348-348: LGTM - Comment terminology updated.

The comment change from "super-voxel" to "supervoxel" maintains consistency with the broader terminology standardization effort. The logic and functionality remain unchanged.

frontend/javascripts/viewer/shaders/segmentation.glsl.ts (1)

475-475: LGTM - Shader comment terminology updated.

The inline comment change from "the hovered super-voxel of the active segment" to "the hovered supervoxel of the active segment" maintains consistency with the project-wide terminology standardization. No functional changes to the shader code.

frontend/javascripts/viewer/model/sagas/volume/proofread_saga.ts (3)

631-631: LGTM - Comment terminology standardized.

The comment update from "super-voxel" to "supervoxel" aligns with the project-wide terminology standardization without affecting any functional logic.


658-658: LGTM - Comment terminology standardized.

The comment change from "clicked super-voxel" to "clicked supervoxel" maintains consistency with the broader terminology updates.


690-690: LGTM - Comment terminology standardized.

The comment update from "active super-voxel" to "active supervoxel" aligns with the consistent terminology changes throughout the codebase.

frontend/javascripts/viewer/view/context_menu.tsx (2)

514-514: Terminology update LGTM

"Supervoxel" casing and hyphen removal are correct. Also, per your previous learning, the nearby segmentIdLabel behavior (showing unmapped ID during proofreading) remains intact.


1042-1042: Terminology update LGTM — repo-wide scan inconclusive

Sandbox ripgrep ignored many files so absence of matches isn't confirmed. Run locally: git grep -nEi 'super-voxel|super voxel|supervoxel' (or rg -n -i -uu --hidden 'super-voxel|super voxel|supervoxel') and resolve any matches.

docs/proofreading/proofreading_tool.md (5)

3-3: Terminology update LGTM

"supervoxel graph structure" reads well and aligns with the new standard.


12-12: Terminology update LGTM

“supervoxel graph” is consistent.


25-25: Terminology update LGTM

“supervoxel graph edges” is consistent.


32-32: Terminology update LGTM

“modify the supervoxel graph” is consistent.


35-35: Terminology update LGTM

“supervoxel graph representation” is consistent.

@MichaelBuessemeyer MichaelBuessemeyer enabled auto-merge (squash) September 25, 2025 08:26
@MichaelBuessemeyer MichaelBuessemeyer merged commit b691714 into master Sep 25, 2025
5 checks passed
@MichaelBuessemeyer MichaelBuessemeyer deleted the supervoxel-naming branch September 25, 2025 08:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants