Line breaks for multi-line comments in Markdown cells are broken (interactive Python)

[xareelee]

Applies To

• Notebooks (.ipynb files)
• Interactive Window and/or Cell Scripts (.py files with #%% markers)

What happened?

In a .py file, I wrote a markdown cell with python strings (multiple line comments):

#%% [markdown]

"""
# H1 Title

description 1

- item 1
    - item 2
- item 3

description 2

- item 4
    - item 5
- item 6
"""

I run the cell (ctrl + enter), but it shows:

The line breaks and the indentation of list items are incorrect.

Additionally, writing code block within python comments

#%% [markdown]

"""
Writing code blocks in markdown:

```shell
# Comment 1
$ ls 

# Comment 2
$ ls -lh
```
"""

shows no line breaks:

VS Code Version

1.66.0

Jupyter Extension Version

v2022.3.1000901801

Jupyter logs

No response

Coding Language and Runtime Version

Python 3.10.2

Language Extension Version (if applicable)

v2022.4.0

Anaconda Version (if applicable)

No response

Running Jupyter locally or remotely?

Local

[rchiodo]

Thanks for the issue. Looks like we're removing the linebreaks when parsing the multiline comment.

Single line comments should work though.

# %% [markdown]
#
#
# # H1 Title
#
# description 1
#
# - item 1
#    - item 2
# - item 3
#
# description 2
#
# - item 4
#    - item 5
# - item 6

[rebornix]

This is not IW specific but a generic markdown cell rendering issue.

[DonJayamanne]

This is an IW issue, as the spaces are trimmed or something is wrong with the markdown.

• Step 1 - Create the following markdown cell in a notebook and check the renderered content

# H1 Title

description 1

- item 1
    - item 2
- item 3

description 2

- item 4
    - item 5
- item 6

• Step 2 - Now run the above code as a cell in IW and the check the markdown output
• The markdown outputs look very different, when in fact they must be identical,
• Step 3: Create a cell in a notebook and add the above content and ensure the first line starts with %%markdown cell magic, and check the output, notice how the markdown is as expected
• In all cases the markdown is rendered correctly except when executed in IW, (even works in notebooks)
  hence the problem lies with the markdown text sent to the kernel by the IW code