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

DOC: Add axes_api to documentation after the refactoring #2427

Merged
merged 2 commits into from Sep 18, 2013

Conversation

jarondl
Copy link

@jarondl jarondl commented Sep 16, 2013

Recently, axes was converted from a module to a package.
This adds axes_api to the doctree back.
show-inheritance was removed because it tells the user that
Axes Bases: matplotlib.axes._base._AxesBase
which is not that relevant I think.
This is mentioned in issue #1461

Recently, axes was converted from a module to a package.
This adds axes_api to the doctree back.
`show-inheritance` was removed because it tells the user that
`Axes` `Bases: matplotlib.axes._base._AxesBase`
which is not that relevant I think.
This is mentioned in issue matplotlib#1461
@mdboom
Copy link
Member

mdboom commented Sep 16, 2013

Aha. Thanks for noticing this. However, I think we want this to get documented as matplotlib.axes.Axes (the public API is constant, though things have moved around), not matplotlib.axes._axes.Axes. I think there's just some Sphinx magic we have to do to make it do that.

with automodule we had: `matplotlib.axes._axes.Axes`
while with autoclass we have `matplotlib.axes.Axes`

However, we must remember this documents only one class, so if
classes will be added to the module, they should be added
by hand.
@jarondl
Copy link
Author

jarondl commented Sep 16, 2013

I've added another commit to the PR

@mdboom
Copy link
Member

mdboom commented Sep 16, 2013

Thanks. Looks good to me. @NelleV may want to have a look as well.

pelson added a commit that referenced this pull request Sep 18, 2013
DOC: Add axes_api to documentation after the refactoring
@pelson pelson merged commit 803e538 into matplotlib:master Sep 18, 2013
@jarondl jarondl deleted the add-Axes-api-doc branch September 18, 2013 18:12
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.

None yet

3 participants