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

fix(pacmak): dotnet code docs loses indentation #3180

Merged
merged 1 commit into from
Nov 17, 2021
Merged

Conversation

kaizencc
Copy link
Contributor

Currently code examples in dotnet lose their indentation styles because we call trim() on each line in the code example. We want that behavior for other types of xml docs but not for code. This PR makes code a special case that calls trimRight() on each line, preserving the indentation on the left.

The only change in the snapshots is translating this example:

docs const x = 12 + 44;
const s1 = "string";
const s2 = "string \nwith new newlines"; // see https://github.com/aws/jsii/issues/2569
const s3 = `string
            with
            new lines`;

to this:

<code>int x = 12 + 44;
string s1 = "string";
string s2 = @"string
with new newlines"; // see https://github.com/aws/jsii/issues/2569
string s3 = @"string
            with
            new lines";</code>

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Nov 16, 2021
@mergify
Copy link
Contributor

mergify bot commented Nov 17, 2021

Thank you for contributing! ❤️ I will now look into making sure the PR is up-to-date, then proceed to try and merge it!

@mergify mergify bot added the pr/ready-to-merge This PR is ready to be merged. label Nov 17, 2021
@mergify mergify bot merged commit ace0b83 into main Nov 17, 2021
@mergify mergify bot deleted the dotnet-indent branch November 17, 2021 08:41
@mergify
Copy link
Contributor

mergify bot commented Nov 17, 2021

Merging (with squash)...

@mergify mergify bot removed the pr/ready-to-merge This PR is ready to be merged. label Nov 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution/core This is a PR that came from AWS.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants