refactor: update to use @see flag (#20)

aleios-cloud · Jun 26, 2023 · fd0a20f · fd0a20f
1 parent a787bfb
commit fd0a20f
Showing 1 changed file with 6 additions and 6 deletions.
diff --git a/constructs/Lambda/types.ts b/constructs/Lambda/types.ts
@@ -11,35 +11,35 @@ export interface RestrictedLambdaConfig {
 
 export interface RequiredLambdaConfig extends Partial<NodejsFunctionProps> {
   /**
-   * Please look at https://aleios-cloud.github.io/sls-constructs/docs/Lambda#function-name for documentation
+   * @see https://aleios-cloud.github.io/sls-constructs/docs/Lambda#function-name
    * @required true
    */
   functionName: string;
   /**
-   * Please look at https://aleios-cloud.github.io/sls-constructs/docs/Lambda#entry for documentation
+   * @see https://aleios-cloud.github.io/sls-constructs/docs/Lambda#entry
    * @required true
    */
   entry: string;
 }
 
 export interface AleiosLambdaProps extends RequiredLambdaConfig {
   /**
-   * Please look at https://aleios-cloud.github.io/sls-constructs/docs/Lambda#runtime for documentation
+   * @see https://aleios-cloud.github.io/sls-constructs/docs/Lambda#runtime
    * @default Runtime.NODEJS_18_X,
    */
   runtime?: RestrictedLambdaConfig['runtime'];
   /**
-   * Please look at https://aleios-cloud.github.io/sls-constructs/docs/Lambda#architecture for documentation
+   * @see https://aleios-cloud.github.io/sls-constructs/docs/Lambda#architecture
    * @default Architecture.ARM_64
    */
   architecture?: RestrictedLambdaConfig['architecture'];
   /**
-   * Please look at https://aleios-cloud.github.io/sls-constructs/docs/Lambda#tracing for documentation
+   * @see https://aleios-cloud.github.io/sls-constructs/docs/Lambda#tracing
    * @default Tracing.ACTIVE
    */
   tracing?: RestrictedLambdaConfig['tracing'];
   /**
-   * Please look at https://aleios-cloud.github.io/sls-constructs/docs/Lambda#retry-attempts for documentation
+   * @see https://aleios-cloud.github.io/sls-constructs/docs/Lambda#retry-attempts
    * @default 2
    */
   retryAttempts?: RestrictedLambdaConfig['retryAttempts'];