Page MenuHomePhabricator

Document API Endpoint Functions with JSDoc Comments
Closed, ResolvedPublic

Description

Domain: Documentation / Translation

Difficulty: Beginner

Description:
The utils/endpoints.ts file contains several functions that lack proper JSDoc comments. Specifically:

  • productionsShared() - has JSDoc but incomplete
  • co_ActorSearch() - missing proper formatting
  • sharedActors() - has JSDoc but is incomplete
  • movieSearch() - comment is incomplete with trailing formatting

Add or complete JSDoc comments for all endpoint functions following the existing pattern, including @param and @returns tags.

Expected Outcome:

  • All endpoint functions have complete JSDoc comments
  • Comments follow consistent formatting
  • Better developer experience and IDE autocomplete

Setup Steps:

  1. Open utils/endpoints.ts.
  2. Review each endpoint function
  3. Add missing or complete JSDoc comments
  4. Ensure consistency with the existing pattern

Links/References:

  • File: utils/endpoints.ts
  • Functions to document: 6 API endpoint functions

Event Timeline

Essa237 subscribed.

Working on this before 10pm today

Change #1217813 had a related patch set uploaded (by Wandji collins; author: Essa237):

[labs/tools/WdTmCollab@main] docs(utils): standardize JSDoc comments in endpoints.ts

https://gerrit.wikimedia.org/r/1217813

Change #1217813 merged by jenkins-bot:

[labs/tools/WdTmCollab@main] docs(utils): standardize JSDoc comments in endpoints.ts

https://gerrit.wikimedia.org/r/1217813