oss-slu / oss-slu/DigitalBoneBox

Clarify which annotations are being used

Open
#316 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement
Dominant language
JavaScript
Stars
8
Forks
18
Avg merge
8h 17m
Merged PRs (30d)
4

Description

🎯 Goal / Objective

A clear and concise description of what this task aims to achieve. Why is this task important?

In our codebase, we are using the word "annotation" to refer to multiple types of annotations applied onto an image. Sometimes the word refers to a "colored region annotation," where a color highlight is overlaid onto a portion of the image, and sometimes it refers to "text labels," which are text overlaid over the image, often with lines pointing from the text to a portion of the image.

There are places in the codebase where "annotation" is being used without clarifying which kind of annotation is being referred to, particularly in annotationOverlay.js. It should be clarified what annotations are being created or manipulated.


✅ Tasks to be Completed

A checklist of the specific, actionable steps required to complete this issue. This helps track progress.

  • Add or reword existing comments or documentation in relevant files to clarify intent.
  • If it seems necessary and helpful, rename symbols to clarify intent.

Acceptance Criteria

A checklist of conditions that must be met for this task to be considered complete. How will we verify that it's done correctly?

  • The new feature is implemented as described.
  • All related code passes the repository's workflow checks (linting, tests).
  • The application runs without errors after the changes are made.
  • (If applicable) New automated tests have been added to cover the changes.
  • Any related documentation has been updated, including JSDoc comments or docstrings

Additional Context

Add any other context, notes, screenshots, or links that might be helpful for completing this task.

Here is an example of an image with both a colored region annotation and a text label annotation (with a pointer line) applied on top:

Image

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading annotationOverlay.js and trace where image annotations are created or manipulated. Distinguish colored region annotations from text labels and update the relevant comments, JSDoc, or symbols so their intent is explicit. Done means the terminology is clear throughout the relevant code and the repository workflow checks pass.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
frontend
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.