Microsoft/vscode

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

Open

#269,627 opened on Apr 7, 2022

View on GitHub
 (3 comments) (2 reactions) (2 assignees)TypeScript (10,221 forks)batch import
bughelp wantedinteractive-window

Repository metrics

Stars
 (74,848 stars)
PR merge metrics
 (Avg merge 11h 43m) (1,000 merged PRs in 30d)

Description

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:

Screen Shot 2022-04-07 at 11 15 05

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:

Screen Shot 2022-04-07 at 12 09 27

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

Contributor guide

Research direction
Investigate how markdown cells in Python interactive window are rendered, focusing on line breaks in multi line comments and code blocks. Check the renderer or markdown parser used.
Tech stack
typescriptpython
Domain
developer experiencetooling
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60