docs(core): errors will fail deployment, not synthesis (#18342)

Fix inaccurate information in the documentation. Closes #18317 ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
aws · Jan 10, 2022 · d94d9ce · d94d9ce
1 parent 304f5b6
commit d94d9ce
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/packages/@aws-cdk/core/lib/annotations.ts b/packages/@aws-cdk/core/lib/annotations.ts
@@ -44,7 +44,7 @@ export class Annotations {
 
   /**
    * Adds an { "error": <message> } metadata entry to this construct.
-   * The toolkit will fail synthesis when errors are reported.
+   * The toolkit will fail deployment of any stack that has errors reported against it.
    * @param message The error message.
    */
   public addError(message: string) {