python: newlines in literal strings example code results in invalid syntax

[eladb]

🐛 Bug Report

Affected Languages

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

General Information

• JSII Version: 1.20.1

What is the problem?

Consider the following jsii code:

/**
 * Hello world, this is cool.
 *
 * @example
 * const s1 = "\nFooBar";
 * const s2 = `Hello
 *   world!`;
 */
export class Hello {
  public sayHello() {
    return 'hello, world!';
  }
}

The generated python output looks like this:

class Hello(metaclass=jsii.JSIIMeta, jsii_type="python-repro.Hello"):
    """Hello world, this is cool.

    Example::

        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        s1 = """
        FooBar"""
        s2 = """Hello
          world!"""
    """

    def __init__(self) -> None:
        jsii.create(Hello, self, [])

    @jsii.member(jsii_name="sayHello")
    def say_hello(self) -> builtins.str:
        return typing.cast(builtins.str, jsii.invoke(self, "sayHello", []))

Notice that the \n in the example code was converted to """ pairs which should be escaped or just left as is since they are part of a string literal.

This was introduced in #2419

[github-actions]

⚠️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.