Skip to content

Commit e274edc

Browse files
authored
docs: fix wrong annotation used in example (#20964)
Used a misleading `@mutating` annotation instead of a `@config` annotation. ---- ### All Submissions: * [ ] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) ### Adding new Unconventional Dependencies: * [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md/#adding-new-unconventional-dependencies) ### New Features * [ ] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/main/INTEGRATION_TESTS.md)? * [ ] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)? *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent 0effc6d commit e274edc

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/DESIGN_GUIDELINES.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -754,10 +754,10 @@ interface IFoo extends IConstruct {
754754
class Foo extends Construct implements IFoo {
755755
public bar() { }
756756

757-
/** @mutating */
757+
@config
758758
public goo() { }
759759

760-
public mutateMe() { } // ERROR! missing "@mutating" or missing on IFoo
760+
public mutateMe() { } // ERROR! missing "@config" or missing on IFoo
761761
}
762762
```
763763

0 commit comments

Comments
 (0)