File tree Expand file tree Collapse file tree 1 file changed +6
-0
lines changed
Expand file tree Collapse file tree 1 file changed +6
-0
lines changed Original file line number Diff line number Diff line change @@ -556,6 +556,12 @@ contain three slashes to achieve the same effect:
556556For a practical example of how making sample code compilable works, see the
557557` aws-ec2 ` package.
558558
559+ > ⚠️ NOTE: README files often contain code snippets that refer to modules that are consumers
560+ > of the current module, and hence not present in the current module's dependency closure.
561+ > Compilation of these snippets will fail if the module referenced has not been built.
562+ > For the best experience when working on snippets, a full build of the CDK repo is required.
563+ > However, it may be prudent to "build up" these modules as required.
564+
559565#### Recommendations
560566
561567In order to offer a consistent documentation style throughout the AWS CDK
You can’t perform that action at this time.
0 commit comments