Skip to content

[PATCH] buildAcceptLanguage JSDoc missing @param type annotation for hostname #204

@ormidales

Description

@ormidales

Category: documentation
Severity: patch
File(s): background.js (buildAcceptLanguage)

Description

The buildAcceptLanguage JSDoc documents the @param with a plain text description but omits the type annotation {string}. Every other documented function in utils.js and background.js uses the full @param {type} name format. The inconsistency makes the codebase harder to process with JSDoc tooling or IDE IntelliSense.

Problematic code example

/**
 * @param hostname The request hostname (e.g. "www.example.fr").
 */

Suggested fix

/**
 * @param {string} hostname The request hostname (e.g. "www.example.fr").
 */

Acceptance criteria

  • @param for hostname includes the {string} type annotation
  • Style is consistent with all other JSDoc @param annotations in the file
  • No behaviour change

Metadata

Metadata

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions