From b7cb59dd7b05c12c57deec022e2726dd02e9e56d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Anders=20N=C3=A4sman?= Date: Thu, 25 Feb 2021 14:45:48 +0100 Subject: [PATCH] standard TODO syntax Signed-off-by: Eric Peterson --- packages/app/src/components/search/SearchPage.tsx | 2 +- packages/backend/src/index.ts | 2 +- plugins/search-backend/src/service/router.ts | 6 +++--- plugins/search-indexer-backend/src/registry.ts | 4 ++-- plugins/search/src/apis.ts | 2 +- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/packages/app/src/components/search/SearchPage.tsx b/packages/app/src/components/search/SearchPage.tsx index d1d03d48ea..c2f0c90208 100644 --- a/packages/app/src/components/search/SearchPage.tsx +++ b/packages/app/src/components/search/SearchPage.tsx @@ -25,7 +25,7 @@ import { Grid } from '@material-ui/core'; import React, { useEffect, useState } from 'react'; import { useDebounce } from 'react-use'; -// @todo Simplify / remove as much state handling here. The goal is for this to +// TODO: Simplify / remove as much state handling here. The goal is for this to // more or less use the publicly exposed components from the search plugin and // not much else. export const SearchPage = () => { diff --git a/packages/backend/src/index.ts b/packages/backend/src/index.ts index fededf0f0a..8feb060de2 100644 --- a/packages/backend/src/index.ts +++ b/packages/backend/src/index.ts @@ -111,7 +111,7 @@ async function main() { process.exit(1); }); - // @todo Start Search Refresh Loop Here? + // TODO: Start Search Refresh Loop Here? } module.hot?.accept(); diff --git a/plugins/search-backend/src/service/router.ts b/plugins/search-backend/src/service/router.ts index 185a92831a..47b7354b22 100644 --- a/plugins/search-backend/src/service/router.ts +++ b/plugins/search-backend/src/service/router.ts @@ -34,7 +34,7 @@ export async function createRouter({ req: express.Request, res: express.Response, ) => { - // @todo Actually transform req.params into search engine specific query. + // TODO: Actually transform req.params into search engine specific query. const { term, filters = {}, pageIndex = 0, pageSize = 30 } = req.query; logger.info( `Search request received: ${term}, ${JSON.stringify( @@ -43,8 +43,8 @@ export async function createRouter({ ); try { - // @todo Actually query search engine. - // @todo And actually transform results into frontend-readable result + // TODO: Actually query search engine. + // TODO: And actually transform results into frontend-readable result res.send({ results: [], }); diff --git a/plugins/search-indexer-backend/src/registry.ts b/plugins/search-indexer-backend/src/registry.ts index 8b71a87e57..609bb7b30f 100644 --- a/plugins/search-indexer-backend/src/registry.ts +++ b/plugins/search-indexer-backend/src/registry.ts @@ -68,7 +68,7 @@ export class Registry { }); } - // @todo But like with coordination, timing, error handling, and what have you. + // TODO: But like with coordination, timing, error handling, and what have you. async execute(): Promise { return new Promise(resolve => { Object.keys(this.collators).forEach(async type => { @@ -81,7 +81,7 @@ export class Registry { documents = await decorators[i](documents); } - // @todo: push documents to a configured search engine. + // TODO: push documents to a configured search engine. resolve(undefined); }); }); diff --git a/plugins/search/src/apis.ts b/plugins/search/src/apis.ts index 65490c3c37..6b739427d7 100644 --- a/plugins/search/src/apis.ts +++ b/plugins/search/src/apis.ts @@ -62,7 +62,7 @@ class SearchApi { return this.entities(); } - // @todo Productionalize as we implement search milestones. + // TODO: Productionalize as we implement search milestones. public async _alphaPerformSearch( query: SearchQuery, ): Promise {