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/python): escape character escapes in python docs #2138

Merged
merged 8 commits into from
Oct 22, 2020

Conversation

jsteinich
Copy link
Contributor

@jsteinich jsteinich commented Oct 18, 2020

Fixes #2137


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

@mergify
Copy link
Contributor

mergify bot commented Oct 18, 2020

The title of this Pull Request does not conform with [Conventional Commits] guidelines. It will need to be adjusted before the PR can be merged.
[Conventional Commits]: https://www.conventionalcommits.org

@jsteinich jsteinich changed the title Escape character escapes in python docs fix(pacmak/python): escape character escapes in python docs Oct 18, 2020
packages/jsii-pacmak/lib/markdown.ts Outdated Show resolved Hide resolved
Comment on lines 116 to 126
test('escape character escaping', () => {
converts(
[
`For example, if you specify \\N, BigQuery interprets \\N as a null value`,
],
[
`For example, if you specify \\\\N, BigQuery interprets \\\\N as a null value`,
],
);
});

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This omits to test for the "must not escape" case.

packages/jsii-pacmak/lib/markdown.ts Outdated Show resolved Hide resolved
jsteinich and others added 2 commits October 19, 2020 07:20
Co-authored-by: Romain Marcadier <romain.muller@telecomnancy.net>
@jsteinich jsteinich marked this pull request as ready for review October 19, 2020 21:46
RomainMuller
RomainMuller previously approved these changes Oct 22, 2020
@RomainMuller RomainMuller added this to the 🎃 October Release milestone Oct 22, 2020
@mergify mergify bot dismissed RomainMuller’s stale review October 22, 2020 14:41

Pull request has been modified.

@mergify
Copy link
Contributor

mergify bot commented Oct 22, 2020

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 Oct 22, 2020
@mergify
Copy link
Contributor

mergify bot commented Oct 22, 2020

Merging (with squash)...

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildProject6AEA49D1-Blkkw9bQFn8A
  • Commit ID: dd550e4
  • 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 1578899 into aws:master Oct 22, 2020
@mergify
Copy link
Contributor

mergify bot commented Oct 22, 2020

Merging (with squash)...

@mergify mergify bot removed the pr/ready-to-merge This PR is ready to be merged. label Oct 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Comments don't escape character escapes
4 participants