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 documentation for mpl_toolkits.axes_grid1.inset_locator#4864

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
tacaswell merged 13 commits intomatplotlib:masterfromsargas:document_inset_locator
Dec 16, 2015

Conversation

sargas
Copy link
Contributor

This module has some nice, undocumented (except in narrative form) helpers that has been interesting to figure out.

I made some formatting changes, and some slight API differences:

  1. AnchoredSizeLocator andAnchoredZoomLocator both overrode__call__ merely to save the axes (which is unused inAnchoredSizeLocator anyways). I moved the saving of this value to the__call__ of their superclass. No other file in matplotlib uses these classes, and the superclass doesn't look used for anything else online.
  2. inset_axes andzoomed_inset_axes take a**kwarg, but the only keyworded argument that would not result in an error isborderpad. I changed the functions to make that clear.

I still haveAnchoredLocatorBase (and its subclasses) to document, but I don't understand the code as is - for instance, a required parameteroffsetbox is always unused, and I don't understand why a locator object (something used withAxes.set_axes_locator) would ever have any method except those used by__call__ (making the capabilities inherited fromAnchoredOffsetBox useless).

@sargassargas changed the titleAdd documentation for mpl_toolkits.axes_grid1Add documentation for mpl_toolkits.axes_grid1.inset_locatorAug 4, 2015
@WeatherGod
Copy link
Member

Docbuild failure, but I don't know what it means:https://api.travis-ci.org/jobs/74123925/log.txt?deansi=true

@sargas
Copy link
ContributorAuthor

I generated the docs in py3 on my local machine, it turns out thededent_interpd decorator doesn't like to work on classes in py2.

I moved the class-level docstrings to the__init__ functions; that allows the docs to build here.
I don't know how the python3.3 error (inmatplotlib.tests.test_backend_ps.test_savefig_to_stringio_with_usetex) could have happened though.

@WeatherGod
Copy link
Member

Ok, that makes sense. Don't worry about that usetex test, it is a transient
one that has to do with the Travis system.
On Aug 4, 2015 8:59 PM, "Joseph Booker"notifications@github.com wrote:

I generated the docs in py3 on my local machine, it turns out the
dedent_interpd decorator doesn't like to work on classes in py2.

I moved the class-level docstrings to theinit functions; that allows
the docs to build here.
I don't know how the python3.3 error (in
matplotlib.tests.test_backend_ps.test_savefig_to_stringio_with_usetex)
could have happened though.


Reply to this email directly or view it on GitHub
#4864 (comment)
.

@tacaswell
Copy link
Member

Awesome!

I have no problem with this sneaking in under the wire for 1.5, but do not have time to review.

@tacaswelltacaswell added this to theproposed next point release milestoneAug 5, 2015
@WeatherGod
Copy link
Member

A question for the other devs... Is there any reason why we continue to have the axes_grid and axes_grid1? From my understanding, axes_grid is "deprecated" and is only kept around for compatibility. Documentation-wise, it looks like only the axes_grid module is actually generated.

@jenshnielsen
Copy link
Member

I would be 👍 on removing axes_grid

@tacaswell
Copy link
Member

Has anyone been able to review this?

@tacaswell
Copy link
Member

@leejjoon Can you review this?

from __future__ import (absolute_import, division, print_function,
unicode_literals)

from matplotlib.externals import six
Copy link
Member

Choose a reason for hiding this comment

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

please leave the six import

@tacaswell
Copy link
Member

Gave this a quick read, looks really good 👍

There are a bunch of places where things need to be put under aNotes section for numpydoc to render them nicely.

In the places where**kwargs is eliminated, it should be checked that all possible keyword args really are covered.

@sargas
Copy link
ContributorAuthor

Thanks for reviewing this.

I don't think thekwargs should go intoNotes, since the keyworded arguments are parameters.

I attempted to do the following inParameters:

    kwargs        Patch properties for the lines and box drawn:        %(Patch)s

This doesn't quite get the formatting right either (the start of the description is misaligned with the start of the descriptions of the other parameters). The generated HTML has an extra<blockquote> element causing this.

@tacaswell
Copy link
Member

I think the priority should be that the docs renderreasonably even if they are not semantically correct.

@sargas
Copy link
ContributorAuthor

Okay. I've also double checked the **kwargs options I removed.

tacaswell added a commit that referenced this pull requestDec 16, 2015
DOC: Add documentation for mpl_toolkits.axes_grid1.inset_locator
@tacaswelltacaswell merged commit4573e1e intomatplotlib:masterDec 16, 2015
@tacaswelltacaswell modified the milestones:next major release (2.0),proposed next point release (2.1)Dec 16, 2015
@tacaswell
Copy link
Member

tacaswell added a commit that referenced this pull requestDec 16, 2015
DOC: Add documentation for mpl_toolkits.axes_grid1.inset_locator
@tacaswell
Copy link
Member

back-ported to 1.5.x as8677af6

@sargassargas deleted the document_inset_locator branchDecember 16, 2015 17:36
@QuLogicQuLogic modified the milestones:Critical bugfix release (1.5.1),next major release (2.0)Dec 16, 2015
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
v1.5.1
Development

Successfully merging this pull request may close these issues.

5 participants
@sargas@WeatherGod@tacaswell@jenshnielsen@QuLogic

[8]ページ先頭

©2009-2025 Movatter.jp