remove newlines from comment block

[jeisner]

Code is often formatted to 80 columns or some similar width.
It would be nice to have a flag so that a word-wrapped comment block like

# The data that we are interested in is made of 8x8 images of digits.
# Let's have a look at the first 4 images, which is of course
# stored in the `images` attribute of the dataset.  

appears like this, where Jupyter gets to wrap to the width of the cell:

The data that we are interested in is made of 8x8 images of digits. Let's have a look at the first 4 images, which is of course stored in the `images` attribute of the dataset.  

Note that the underlying Markdown would still have the line breaks, in case the user wants to edit it to restore any intended line break.

The data that we are interested in is made of 8x8 images of digits. 
Let's have a look at the first 4 images, which is of course 
stored in the `images` attribute of the dataset.  

[jeisner]

Currently I do this by postprocessing. You can correct the output file output.ipynb by removing the line breaks <br> that p2j inserts before the newline at the end of each markdown string:
perl -i -pe 's/<br>(?=\\n")//g' output.ipynb
Here's a better version that preserves a line break before an indented line.
perl -i -pe 's/<br>(?=\\n", "\S)//g' output.ipynb
Either version will preserve blank lines, e.g., between paragraphs.

However, this solution isn't bulletproof because it just does local pattern matching. It would be better to have a command-line option to p2j that avoids inserting <br> in the first place. That's also more user-friendly.

[remykarem]

Hi, Jason. I’m currently not actively maintaining this so it might take quite some time for me to get gather some context. Would you like to make a PR for this?

…

On Sun, 19 Nov 2023 at 6:05 AM, Jason Eisner ***@***.***> wrote: Reopened #15 <#15>. — Reply to this email directly, view it on GitHub <#15 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ACUDL46KLBWQLL4QHQLJT6DYFEWI7AVCNFSM6AAAAAA7RET3QKVHI2DSMVQWIX3LMV45UABCJFZXG5LFIV3GK3TUJZXXI2LGNFRWC5DJN5XDWMJRGAYDENJVG4ZTSOA> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

[jeisner]

Looking at your p2j.py code and specifically at the part that adds <br>, it looks like you already included some logic that tries to determine where to add line breaks?

I might disagree with your choices there, but I'm afraid that if I just got rid of <br>, I would be breaking some cases where you deliberately wanted (which I may not have encountered).

[AdrianSosic]

I would be also interested in this feature 👍🏼