mne-tools / mne-tools/mne-python

JupyterLite mangles admonitions

Open
#14,311 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
3.5k
Forks
1.6k
Avg merge
1d 6h
Merged PRs (30d)
100

Description

follow-up to #14157 --- the admonitions don't look quite right in the jupyterlite notebook.

Image

Notice the HTML closing tags (p and div) after the code sample. Is this something we have any control over, or is it an upstream bug? @natinew77-creator @larsoner

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the related issue #14157 and reproducing the admonition rendering in the JupyterLite notebook. Trace the HTML closing tags after the code sample to determine whether they are produced by this project or upstream. Done means the source of the malformed rendering is identified and, if controlled here, the admonition displays correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter, jupyter-notebook, python
Domain
documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Needs clarification
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.