w3c / w3c/wot-scripting-api

Should we refactor `getThingDescription` to a JS getter?

Open
#507 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

API-improvement
Dominant language
HTML
Stars
45
Forks
21
PR merge metrics
No merged PRs in 30d

Description

Currently, we are using a method but we could use a simple getter interface. There was some discussion on this point that we might dig up.

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 locating the getThingDescription method and its call sites in the Scripting API, then look for the earlier discussion referenced in the issue. Determine whether the public interface should remain a method or become a JavaScript getter, and document the decision and its affected usage before making changes.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
api
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.