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.

Sign up for GitHub

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

Jump to bottom

Comments don't escape character escapes #2137

Closed
1 of 4 tasks
jsteinich opened this issue Oct 18, 2020 · 1 comment · Fixed by #2138
Closed
1 of 4 tasks

Comments don't escape character escapes #2137

jsteinich opened this issue Oct 18, 2020 · 1 comment · Fixed by #2138
Assignees
@MrArnoldPalmer
Labels
bug This issue is a bug. in-progress Issue is being actively worked on. language/python Related to Python bindings needs-triage This issue or PR still needs to be triaged.

Comments

@jsteinich
Copy link
Contributor

🐛 Bug Report

Affected Languages

  • TypeScript or Javascript
  • Python
  • Java
  • .NET (C#, F#, ...)

General Information

  • JSII Version: 1.1.0

What is the problem?

If a comment contains what looks like a character escape, for example \N, it remains unescaped in the generated python comments. If it happens to be a valid escape, then it isn't that big of a deal, but if it isn't, then referencing the generated code results in an error of the form malformed character escape.

Verbose Log

hashicorp/terraform-cdk#394 has some more details.
@jsteinich jsteinich added bug This issue is a bug. needs-triage This issue or PR still needs to be triaged. labels Oct 18, 2020
@jsteinich jsteinich mentioned this issue Oct 18, 2020
Merged
@SomayaB SomayaB added the language/python Related to Python bindings label Oct 19, 2020
@SomayaB SomayaB added the in-progress Issue is being actively worked on. label Oct 19, 2020
@mergify mergify bot closed this as completed in #2138 Oct 22, 2020
mergify bot pushed a commit that referenced this issue Oct 22, 2020
@jsteinich
fix(pacmak/python): escape character escapes in python docs (#2138)
1578899 
Fixes #2137 

---

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

[Apache 2.0 license]: https://www.apache.org/licenses/LICENSE-2.0
@github-actions
Copy link
Contributor

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

@jsteinich jsteinich mentioned this issue Nov 4, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@MrArnoldPalmer MrArnoldPalmer

Labels
bug This issue is a bug. in-progress Issue is being actively worked on. language/python Related to Python bindings needs-triage This issue or PR still needs to be triaged.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix(pacmak/python): escape character escapes in python docs jsteinich/jsii
3 participants
@jsteinich @MrArnoldPalmer @SomayaB