Skip to content

Commit d94d9ce

Browse files
authored
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*
1 parent 304f5b6 commit d94d9ce

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

packages/@aws-cdk/core/lib/annotations.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ export class Annotations {
4444

4545
/**
4646
* Adds an { "error": <message> } metadata entry to this construct.
47-
* The toolkit will fail synthesis when errors are reported.
47+
* The toolkit will fail deployment of any stack that has errors reported against it.
4848
* @param message The error message.
4949
*/
5050
public addError(message: string) {

0 commit comments

Comments
 (0)