chore: fixing review comments

Signed-off-by: blam <ben@blam.sh>

plugins/scaffolder-backend/src/scaffolder/tasks/StorageTaskBroker.ts

@@ -145,7 +145,7 @@ export class StorageTaskBroker implements TaskBroker {
   private deferredDispatch = defer();
 
   /**
-   * @inheritdoc
+   * {@inheritdoc TaskBroker.claim}
    */
   async claim(): Promise<TaskContext> {
     for (;;) {
@@ -167,7 +167,7 @@ export class StorageTaskBroker implements TaskBroker {
   }
 
   /**
-   * @inheritdoc
+   * {@inheritdoc TaskBroker.dispatch}
    */
   async dispatch(
     options: TaskBrokerDispatchOptions,
@@ -180,14 +180,14 @@ export class StorageTaskBroker implements TaskBroker {
   }
 
   /**
-   * @inheritdoc
+   * {@inheritdoc TaskBroker.get}
    */
   async get(taskId: string): Promise<SerializedTask> {
     return this.storage.getTask(taskId);
   }
 
   /**
-   * @inheritdoc
+   * {@inheritdoc TaskBroker.event$}
    */
   event$(options: {
     taskId: string;
@@ -219,7 +219,7 @@ export class StorageTaskBroker implements TaskBroker {
   }
 
   /**
-   * @inheritdoc
+   * {@inheritdoc TaskBroker.vacuumTasks}
    */
   async vacuumTasks(options: { timeoutS: number }): Promise<void> {
     const { tasks } = await this.storage.listStaleTasks(options);

plugins/scaffolder-common/src/TaskSpec.ts

@@ -48,7 +48,7 @@ export interface TaskStep {
    */
   name: string;
   /**
-   * The underlying action ID that will be called part of running this step.
+   * The underlying action ID that will be called as part of running this step.
    */
   action: string;
   /**
@@ -56,7 +56,7 @@ export interface TaskStep {
    */
   input?: JsonObject;
   /**
-   * When this is false, or if the templated value string evaluates to something that is false the step will be skipped.
+   * When this is false, or if the templated value string evaluates to something that is falsy the step will be skipped.
    */
   if?: string | boolean;
 }
@@ -73,7 +73,7 @@ export interface TaskSpecV1beta3 {
    */
   apiVersion: 'scaffolder.backstage.io/v1beta3';
   /**
-   * This is a JSONSchema or an array of JSONSchema's which is used to render a form in the frontend
+   * This is a JSONSchema which is used to render a form in the frontend
    * to collect user input and validate it against that schema. This can then be used in the `steps` part below to template
    * variables passed from the user into each action in the template.
    */

plugins/scaffolder-common/src/TemplateEntityV1beta3.ts

@@ -67,7 +67,7 @@ export interface TemplateEntityV1beta3 extends Entity {
      */
     output?: { [name: string]: string };
     /**
-     * The owner of the TemplateEntity
+     * The owner entityRef of the TemplateEntity
      */
     owner?: string;
   };