Skip to content

Commit

Permalink
docs: fix wrong annotation used in example (#20964)
Browse files Browse the repository at this point in the history
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*
  • Loading branch information
GuyDev1 authored Jul 5, 2022
1 parent 0effc6d commit e274edc
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/DESIGN_GUIDELINES.md
Original file line number Diff line number Diff line change
Expand Up @@ -754,10 +754,10 @@ interface IFoo extends IConstruct {
class Foo extends Construct implements IFoo {
public bar() { }

/** @mutating */
@config
public goo() { }

public mutateMe() { } // ERROR! missing "@mutating" or missing on IFoo
public mutateMe() { } // ERROR! missing "@config" or missing on IFoo
}
```
Expand Down

0 comments on commit e274edc

Please sign in to comment.