Address warnings within api-docs

Move extra info on doc to be under remarks block

Signed-off-by: Jussi Hallila <jussi@hallila.com>
This commit is contained in:
Jussi Hallila
2021-10-29 15:14:51 +02:00
parent 9c19d6ad01
commit b863feefbb
3 changed files with 15 additions and 12 deletions
@@ -23,6 +23,12 @@ import {
*
* A helper function to construct fact retriever registrations.
*
* @param cadence - cron expression to indicate when the fact retriever should be triggered
* @param factRetriever - Implementation of fact retriever consisting of at least id, version, schema and handler
*
*
* @remarks
*
* Cron expressions help:
* ┌────────────── second (optional)
# │ ┌──────────── minute
@@ -34,9 +40,6 @@ import {
# │ │ │ │ │ │
# * * * * * *
*
*
* @param cadence - cron expression to indicate when the fact retriever should be triggered
* @param factRetriever - Implementation of fact retriever consisting of at least id, version, schema and handler
*/
export function createFactRetrieverRegistration(
cadence: string,