mitmproxy / mitmproxy/pdoc

Matrix with two rows appears smooshed into a single line

Open
#781 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
Python
Stars
2.5k
Forks
228
PR merge metrics
No merged PRs in 30d

Description

Problem Description

Documentation in the form

    r"""
    Compute rigid link stiffness matrix.

    The stiffness matrix is computed as

    $$
    K =\begin{bmatrix} 
          C^T\Gamma C & -C^T\Gamma  \\
          -\Gamma C & \Gamma \\
       \end{bmatrix}
    $$.

    """

produces

Image

The matrix rows are all on the same line.

The generated html:

Image

Steps to reproduce the behavior:
  1. See above.
  2. Compiled with pdoc pystran --math -o html.
System Information

pdoc: 15.0.1
Python: 3.13.2
Platform: Windows-11-10.0.22631-SP0

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

Reproduce the issue with pdoc pystran --math -o html using the docstring shown, then inspect the generated HTML and rendered matrix. Trace how the displayed LaTeX matrix rows are emitted and confirm the fix by regenerating the page and verifying that the two rows render separately.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.