chore: use @todo jsdoc tags for missed inline todo comments

Fdawgs · Sep 28, 2023 · 8df9f3e · 8df9f3e
1 parent fa538af
commit 8df9f3e
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 5 deletions.
diff --git a/src/routes/admin/access/bearer-token/index.js b/src/routes/admin/access/bearer-token/index.js
@@ -281,8 +281,10 @@ async function route(server, options) {
  const page = parseInt(req.query.page, 10) - 1;
  const perPage = parseInt(req.query.per_page, 10);
 
- // Stops SQL query with empty WHERE clause from being made and throwing errors
- // TODO: replace with JSON Schema subschemas when supported
+ /**
+ * Stops SQL query with empty WHERE clause from being made and throwing errors
+ * @todo replace with JSON Schema subschemas when supported
+ */
  if (whereArray.length === 0) {
  return res.badRequest(
  "No valid query string parameters provided"

diff --git a/src/routes/contact/index.js b/src/routes/contact/index.js
@@ -310,8 +310,10 @@ async function route(server, options) {
  const page = parseInt(req.query.page, 10) - 1;
  const perPage = parseInt(req.query.per_page, 10);
 
- // Stops SQL query with empty WHERE clause from being made and throwing errors
- // TODO: replace with JSON Schema subschemas when supported
+ /**
+ * Stops SQL query with empty WHERE clause from being made and throwing errors
+ * @todo replace with JSON Schema subschemas when supported
+ */
  if (whereArray.length === 0) {
  return res.badRequest(
  "No valid query string parameters provided"

diff --git a/src/server.test.js b/src/server.test.js
@@ -581,7 +581,7 @@ describe("Server deployment", () => {
  });
 
  describe("/admin/access/bearer-token/:id route", () => {
- // TODO: use `it.concurrent.each()` once it is no longer experimental
+ /** @todo use `it.concurrent.each()` once it is no longer experimental */
  it.each([
  {
  testName: "basic auth username invalid",