Thanks to visit codestin.com
Credit goes to github.com

Skip to content

adding show inheritance to autosummary template #11833

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

Merged
merged 1 commit into from
Aug 10, 2018

Conversation

fredrik-1
Copy link
Contributor

This small edit make the inheritance show up in the docstring for classes when the default template autosummary.rst is used. I think that it should be included.

@tacaswell tacaswell added this to the v3.0 milestone Aug 9, 2018
@tacaswell
Copy link
Member

In principle I am 👍 , but we need to check that this does not make the pages less readable.

@fredrik-1
Copy link
Contributor Author

Ok, so this didn't work on methods. I just thought that the directive should be ignored when it was not applicable. Lets see if I try to write it with if statements or just ignore this. I think that there are often better templates to use.

@fredrik-1 fredrik-1 force-pushed the autosummary_template branch 3 times, most recently from 8d50bac to 454d24e Compare August 10, 2018 06:47
@fredrik-1 fredrik-1 force-pushed the autosummary_template branch from 454d24e to 2ce33dd Compare August 10, 2018 07:49
@fredrik-1
Copy link
Contributor Author

I used an if statement. This is a small but I think useful change.

It just adds a line that shows the base classes.

With this pr.
figure_inheritance_new

Without this pr.
figure_inheritance_old

@tacaswell
Copy link
Member

oh, I miss understood what this would do (thought it was going to put in the gaphviz generated diagrams) 🐑 .

@tacaswell tacaswell merged commit f4ae5d1 into matplotlib:master Aug 10, 2018
@fredrik-1 fredrik-1 deleted the autosummary_template branch August 19, 2018 14:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants