standard TODO syntax

Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
This commit is contained in:
Anders Näsman
2021-02-25 14:45:48 +01:00
committed by Eric Peterson
parent 925f5847de
commit b7cb59dd7b
5 changed files with 8 additions and 8 deletions
@@ -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 = () => {
+1 -1
View File
@@ -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();
+3 -3
View File
@@ -34,7 +34,7 @@ export async function createRouter({
req: express.Request<any, unknown, unknown, SearchQuery>,
res: express.Response<SearchResultSet>,
) => {
// @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: [],
});
@@ -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<void> {
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);
});
});
+1 -1
View File
@@ -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<SearchResultSet> {