jsdoc / jsdoc/jsdoc

Interface to list their implementations

Open
#1,275 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
15.5k
Forks
1.5k
Avg merge
10d 23h
Merged PRs (30d)
1

Description

I noticed that in the templates for the docs, there is a section that should be listing the implementations of an interface. However, in code, no where are we setting such implementations. I've got something working for that but it was quickly hacked together so likely to contain bugs and the like. Before I get too far ahead though, I wanted to know why the templates have the section but code have no support for it. Was it just simply missed? Was it removed? Is someone currently working on it?

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 comparing the documentation templates' implementations section with the code that populates template data; the issue does not identify specific files or tests. Determine whether interface implementations are intentionally unsupported, removed, or missing, then define and verify the expected behavior before considering an implementation.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.