Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: revert activate 'rosetta infuse' feature #17207

Merged
merged 1 commit into from
Oct 28, 2021

Conversation

rix0rrr
Copy link
Contributor

@rix0rrr rix0rrr commented Oct 28, 2021

The examples we copy into docblocks may contain block comments themselves.

However, the docblock renderer does not escape the docblock closing text, so the doc block gets terminated early and compiling fails:

/**
 * Initialization props for the `NestedStack` construct.
 * <p>
 * Example:
 * <p>
 * <blockquote><pre>{@code
 * // Example automatically generated. See https://github.com/aws/jsii/issues/826
 * import software.amazon.awscdk.core.App;
 * import software.amazon.awscdk.core.CfnOutput;
 * import software.amazon.awscdk.core.NestedStack;
 * import lib.RestApi;
 * import lib.Stage;
 * /**
 *  * This file showcases how to split up a RestApi's Resources and Methods across nested stacks.
 *  *
 *  * The root stack 'RootStack' first defines a RestApi.
 *  * Two nested stacks BooksStack and PetsStack, create corresponding Resources '/books' and '/pets'.
 *  * They are then deployed to a 'prod' Stage via a third nested stack - DeployStack.
 *  *
 *  * To verify this worked, go to the APIGateway
 *  */    <------------ OOOPS!
 * public class RootStack extends Stack {
 *     public RootStack(Construct scope) {
 *         super(scope, "integ-restapi-import-RootStack");
 *         RestApi restApi = RestApi.Builder.cre

Revert this until we can address the quoting issue.

Reverts #17191

@rix0rrr rix0rrr requested a review from a team October 28, 2021 09:08
@rix0rrr rix0rrr self-assigned this Oct 28, 2021
@gitpod-io
Copy link

gitpod-io bot commented Oct 28, 2021

@github-actions github-actions bot added the @aws-cdk/core Related to core CDK functionality label Oct 28, 2021
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Oct 28, 2021
@mergify
Copy link
Contributor

mergify bot commented Oct 28, 2021

Title does not follow the guidelines of Conventional Commits. Please adjust title before merge.

@rix0rrr rix0rrr changed the title Revert "chore: activate 'rosetta infuse' feature" chore: revert activate 'rosetta infuse' feature Oct 28, 2021
@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildProject89A8053A-LhjRyN9kxr8o
  • Commit ID: cf10bfc
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@mergify mergify bot merged commit c4ba858 into master Oct 28, 2021
@mergify mergify bot deleted the revert-17191-huijbers/activate-infuse branch October 28, 2021 10:02
@mergify
Copy link
Contributor

mergify bot commented Oct 28, 2021

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

TikiTDO pushed a commit to TikiTDO/aws-cdk that referenced this pull request Feb 21, 2022
The examples we copy into docblocks may contain block comments themselves.

However, the docblock renderer does not escape the docblock *closing* text, so the doc block gets terminated early and compiling fails:

```java
/**
 * Initialization props for the `NestedStack` construct.
 * <p>
 * Example:
 * <p>
 * <blockquote><pre>{@code
 * // Example automatically generated. See aws/jsii#826
 * import software.amazon.awscdk.core.App;
 * import software.amazon.awscdk.core.CfnOutput;
 * import software.amazon.awscdk.core.NestedStack;
 * import lib.RestApi;
 * import lib.Stage;
 * /**
 *  * This file showcases how to split up a RestApi's Resources and Methods across nested stacks.
 *  *
 *  * The root stack 'RootStack' first defines a RestApi.
 *  * Two nested stacks BooksStack and PetsStack, create corresponding Resources '/books' and '/pets'.
 *  * They are then deployed to a 'prod' Stage via a third nested stack - DeployStack.
 *  *
 *  * To verify this worked, go to the APIGateway
 *  */    <------------ OOOPS!
 * public class RootStack extends Stack {
 *     public RootStack(Construct scope) {
 *         super(scope, "integ-restapi-import-RootStack");
 *         RestApi restApi = RestApi.Builder.cre

```

Revert this until we can address the quoting issue.

Reverts aws#17191
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
@aws-cdk/core Related to core CDK functionality contribution/core This is a PR that came from AWS.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants