Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement attributions ? #280

Open
Carreau opened this issue Sep 7, 2023 · 3 comments
Open

Implement attributions ? #280

Carreau opened this issue Sep 7, 2023 · 3 comments
Labels
enhancement New feature or request question Further information is requested

Comments

@Carreau
Copy link
Member

Carreau commented Sep 7, 2023

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.

@asmeurer
Copy link
Collaborator

asmeurer commented Sep 7, 2023

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?

@asmeurer
Copy link
Collaborator

asmeurer commented Sep 8, 2023

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.

@Carreau
Copy link
Member Author

Carreau commented Sep 12, 2023

Ah, thanks, you are right.

@melissawm melissawm added enhancement New feature or request question Further information is requested labels Oct 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request question Further information is requested
Projects
None yet
Development

No branches or pull requests

3 participants