Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

add subplots to axes documentation#11454

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged

Conversation

fredrik-1
Copy link
Contributor

Added the _subplots module to the axes documentation. Changedsubplot_class_factory docstring to a docstring and put:nosignatures: in thefigure_api.rst file because I think it looks nicer.

  • Has Pytest style unit tests
  • Code is PEP 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

@fredrik-1fredrik-1force-pushed thedoc_rendering_subplots branch from37ff66d to3f0533fCompareJune 18, 2018 14:28

.. contents:: Table of Contents
:depth: 2
:local:
:backlinks: entry
:class: multicol-toc

Subplots
Copy link
Member

@jklymakjklymakJun 18, 2018
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

This appears in the TOC as a level above "Plotting", so I think needs a lower decoration level:

https://10464-1385122-gh.circle-artifacts.com/0/home/circleci/project/doc/build/html/api/axes_api.html

Copy link
ContributorAuthor

@fredrik-1fredrik-1Jun 18, 2018
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I tried to change the header hierarchy without checking the result... and I see now that didn't work and that I didn't know how headers works in rst. I tried to lower the subplot level and that level stayed the same but everything else toggled its level... Tries again.

edit: I thought I pushed a new version yesterday but something went wrong. It should be updated now.

Copy link
Member

@timhoffmtimhoffmJun 18, 2018
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I don't think this is going the right way. This whole page was documenting theAxes class. You've now changed it to theaxes module and inserted the subplots stuff in between the class description and the list of functions (the sections here are used to group theAxes methods by topic).

It may be ok to document the completeaxes module here, but then one would have to change the structure. The TOC is currently "within the class" and only listing its functions.

It would have to go to the top and be restructured to something like:

  • Axes
    • Plotting
    • ...
  • Subplots

Copy link
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

But why should there be a special page for documenting the Axes class instead of the axes module?

But the page can of course be restructured in same way.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

TheAxes class is so large and fundamental, that it might have a dedicated page. But I'm not saying it has to be that way. I also laid out a possible structure if the file should contain the whole module.

Copy link
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I am not sure what is the best. Your structure is of course a possibility (it was not in your post when I wrote my answer).

I am thinking that axes is one module, it consist of 2 public classes and a factory function. Most axes used in practice are also subplots. The suggest structure show the 2 classes and the factory function at the beginning in a way that don't take up to much place and I doubt that the order is confusing.

What about changing the name tosubplot sub module or something like that?

One problem is that the axes module is not included in the module list in neither version of the documents.

@fredrik-1fredrik-1force-pushed thedoc_rendering_subplots branch from3f0533f to656e86eCompareJune 18, 2018 18:17
@tacaswelltacaswell added this to thev3.0 milestoneJun 18, 2018
@tacaswelltacaswell added the Release criticalFor bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions. labelJun 18, 2018
Copy link
Member

@jklymakjklymak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I’m approving as is. Having the subplots module where it is is a bit jarring, but at least its now appearing in the docs, which it wasn’t before. We can make further changes if we hate it (maybe move to the bottom)

@jklymakjklymak merged commit2b51fa3 intomatplotlib:masterJun 21, 2018
@fredrik-1fredrik-1 deleted the doc_rendering_subplots branchJune 23, 2018 13:55
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@timhoffmtimhoffmtimhoffm left review comments

@jklymakjklymakjklymak approved these changes

Assignees
No one assigned
Labels
DocumentationRelease criticalFor bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions.
Projects
None yet
Milestone
v3.0.0
Development

Successfully merging this pull request may close these issues.

5 participants
@fredrik-1@jklymak@timhoffm@tacaswell@dstansby

[8]ページ先頭

©2009-2025 Movatter.jp