jupyter/papyri

Implement attributions ?

Opened this issue · 3 comments

It seem attribution are used in a couple of places.

For example: scipy.stats._continuous_distns:crystalball_gen._pdf use an attribution and the docs fails there.

What is an attribution? This is the scipy.stats._continuous_distns:crystalball_gen._pdf docstring:

        """
        Return PDF of the crystalball function.

                                            --
                                           | exp(-x**2 / 2),  for x > -beta
        crystalball.pdf(x, beta, m) =  N * |
                                           | A * (B - x)**(-m), for x <= -beta
                                            --
        """

Is the pseudo-math being parsed as some RST thing?

It's this https://docutils.sourceforge.io/docs/ref/rst/directives.html#epigraph

Actually implementing that shouldn't be high priority until we see an actual use of it.

This is an example of an internal docstring that was never designed to be parsed as valid rst.

Ah, thanks, you are right.