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
Category: documentation
Severity: patch
File(s):
background.js(buildAcceptLanguage)Description
The
buildAcceptLanguageJSDoc documents the@paramwith a plain text description but omits the type annotation{string}. Every other documented function inutils.jsandbackground.jsuses the full@param {type} nameformat. The inconsistency makes the codebase harder to process with JSDoc tooling or IDE IntelliSense.Problematic code example
Suggested fix
Acceptance criteria
@paramforhostnameincludes the{string}type annotation@paramannotations in the file