IntelPython / dpnp / 34359622736

78%

push

github

Fix documentation rendering for dpnp.ndarray operator methods and dpnp.histogram2d (#3064)

Fixes several documentation rendering issues.

- `dpnp.ndarray` operator methods documented their behavior with a
`:math:` role wrapping the expression in `\text{...}`. In LaTeX/MathJax
math mode `&`, `^`, and `%` are special, so `__and__`, `__xor__`,
`__mod__` and their variants rendered as error strings or truncated
text. These are plain Python operator snippets, so they now render as
inline code literals; all operator dunder docstrings were converted for
consistency.
- `dpnp.histogram2d` and `dpnp.left_shift` were missing the blank line
before their `Returns` section, so numpydoc did not parse it as a
section header.

1546 of 2894 branches covered (53.42%)

Branch coverage included in aggregate %.

26631 of 33004 relevant lines covered (80.69%)

8620.53 hits per line