Docs: Axes.inset_rectangle is referred to but does not exist #14275

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.

Sign up for GitHub

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

Jump to bottom

Closed

clbarnes opened this issue May 20, 2019 · 2 comments

Milestone

Contributor

clbarnes commented May 20, 2019

The documentation page for Axes.indicate_inset_zoom explains the method's kwargs by referring to another method, Axes.inset_rectangle. However, this method does not exist in matplotlib 3.0.x or 3.1.x, and no documentation page can be found by the page search.

The text was updated successfully, but these errors were encountered:

clbarnes changed the title ~~Docs:~~ Docs: Axes.inset_rectangle is referenced by does not exist

clbarnes changed the title ~~Docs: Axes.inset_rectangle is referenced by does not exist~~ Docs: Axes.inset_rectangle is referred to but does not exist

Contributor Author

clbarnes commented May 20, 2019

Additionally, in the docs for Axes.indicate_inset_zoom the return value connector_lines claims to be a 4-tuple, but is actually a list.

clbarnes added a commit to clbarnes/matplotlib that referenced this issue


          Docs: Axes.indicate_inset* methods

740b878

1. Method docstring stated that they output a tuple when it was a list;
now fixed
2. Docstring for indicate_inset_zoom referred to nonexistent method
Axes.inset_rectangle; now correctly refers to Axes.indicate_inset.
3. Fixed possible bug where depending on inputs, one of the return vars
may not have been defined.

See issue matplotlib#14275

clbarnes added a commit to clbarnes/matplotlib that referenced this issue


          Docs: Axes.indicate_inset* methods

e6475b1

1. Method docstring stated that they output a tuple when it was a list;
now fixed
2. Docstring for indicate_inset_zoom referred to nonexistent method
Axes.inset_rectangle; now correctly refers to Axes.indicate_inset.
3. Fixed possible bug where depending on inputs, one of the return vars
may not have been defined.

See issue matplotlib#14275

clbarnes added a commit to clbarnes/matplotlib that referenced this issue


          TST: Axes.indicate_inset failure

bb54fd1

See matplotlib#14275

inset_ax argument is meant to be optional, but currently fails if not
given.

clbarnes added a commit to clbarnes/matplotlib that referenced this issue


          DOC: Axes.indicate_inset* methods

6f10cbf

1. Method docstring stated that they output a tuple when it was a list;
now fixed
2. Docstring for indicate_inset_zoom referred to nonexistent method
Axes.inset_rectangle; now correctly refers to Axes.indicate_inset.
3. Fixed possible bug where depending on inputs, one of the return vars
may not have been defined.

See issue matplotlib#14275

clbarnes added a commit to clbarnes/matplotlib that referenced this issue


          DOC: Axes.indicate_inset* methods

c57a5e3

1. Method docstring stated that they output a tuple when it was a list;
now fixed
2. Docstring for indicate_inset_zoom referred to nonexistent method
Axes.inset_rectangle; now correctly refers to Axes.indicate_inset.
3. Fixed possible bug where depending on inputs, one of the return vars
may not have been defined.

See issue matplotlib#14275

clbarnes mentioned this issue

Axes.indicate_inset* docstring corrections and undefined value fix #14277

Closed

clbarnes added a commit to clbarnes/matplotlib that referenced this issue


          TST: Axes.indicate_inset failure

df49fff

See matplotlib#14275

inset_ax argument is meant to be optional, but currently fails if not
given.

clbarnes added a commit to clbarnes/matplotlib that referenced this issue


          DOC: Axes.indicate_inset* methods

6da1800

1. Method docstring stated that they output a tuple when it was a list;
now fixed
2. Docstring for indicate_inset_zoom referred to nonexistent method
Axes.inset_rectangle; now correctly refers to Axes.indicate_inset.

See issue matplotlib#14275

clbarnes added a commit to clbarnes/matplotlib that referenced this issue


          FIX: Axes.indicate_inset failure

5b68a4d

See matplotlib#14275.

inset_ax argument should be optional, but was failing because it tried
to return a variable which was not defined. This is now fixed.

clbarnes added a commit to clbarnes/matplotlib that referenced this issue


          DOC: Axes.indicate_inset* methods

767715f

1. Method docstring stated that they output a tuple when it was a list;
now fixed
2. Docstring for indicate_inset_zoom referred to nonexistent method
Axes.inset_rectangle; now correctly refers to Axes.indicate_inset.

See issue matplotlib#14275

clbarnes added a commit to clbarnes/matplotlib that referenced this issue


          TST: Axes.indicate_inset failure

608dc00

See matplotlib#14275

inset_ax argument is meant to be optional, but currently fails if not
given.

clbarnes added a commit to clbarnes/matplotlib that referenced this issue


          FIX: Axes.indicate_inset failure

5bac860

See matplotlib#14275.

inset_ax argument should be optional, but was failing because it tried
to return a variable which was not defined. This is now fixed.

clbarnes mentioned this issue

Inset axes bug and docs fix #14278

Merged

clbarnes added a commit to clbarnes/matplotlib that referenced this issue


          TST: Axes.indicate_inset failure

702c583

See matplotlib#14275

inset_ax argument is meant to be optional, but currently fails if not
given.

clbarnes added a commit to clbarnes/matplotlib that referenced this issue


          FIX: Axes.indicate_inset* methods

d4cb805

See matplotlib#14275

1. Methods now return a tuple as documented, instead of a list.
2. indicate_inset() now does not error when optional inset_ax is not
passed, but returns None instead of a tuple.

clbarnes added a commit to clbarnes/matplotlib that referenced this issue


          TST: Axes.indicate_inset failure

e3a7a09

See matplotlib#14275

inset_ax argument is meant to be optional, but currently fails if not
given.

clbarnes added a commit to clbarnes/matplotlib that referenced this issue


          FIX: Axes.indicate_inset* methods

00468ab

See matplotlib#14275

1. Methods now return a tuple as documented, instead of a list.
2. indicate_inset() now does not error when optional inset_ax is not
passed, but returns None instead of a tuple.

clbarnes added a commit to clbarnes/matplotlib that referenced this issue


          TST: Axes.indicate_inset failure

ea18c49

See matplotlib#14275

inset_ax argument is meant to be optional, but currently fails if not
given.

clbarnes added a commit to clbarnes/matplotlib that referenced this issue


          FIX: Axes.indicate_inset* methods

fa553b1

See matplotlib#14275

1. Methods now return a tuple as documented, instead of a list.
2. indicate_inset() now does not error when optional inset_ax is not
passed, but returns None instead of a tuple.

clbarnes added a commit to clbarnes/matplotlib that referenced this issue


          TST: Axes.indicate_inset failure

07117b9

See matplotlib#14275

inset_ax argument is meant to be optional, but currently fails if not
given.

clbarnes added a commit to clbarnes/matplotlib that referenced this issue


          FIX: Axes.indicate_inset* methods

81399c6

See matplotlib#14275

1. Methods now return a tuple as documented, instead of a list.
2. indicate_inset() now does not error when optional inset_ax is not
passed, but returns None instead of a tuple.

clbarnes added a commit to clbarnes/matplotlib that referenced this issue


          TST: Axes.indicate_inset failure

4e2190e

See matplotlib#14275

inset_ax argument is meant to be optional, but currently fails if not
given.

clbarnes added a commit to clbarnes/matplotlib that referenced this issue


          FIX: Axes.indicate_inset* methods

11b3f94

See matplotlib#14275

1. Methods now return a tuple as documented, instead of a list.
2. indicate_inset() now does not error when optional inset_ax is not
passed, but returns None instead of a tuple.

clbarnes added a commit to clbarnes/matplotlib that referenced this issue


          TST: Axes.indicate_inset failure

4e46968

See matplotlib#14275

inset_ax argument is meant to be optional, but currently fails if not
given.

clbarnes added a commit to clbarnes/matplotlib that referenced this issue


          FIX: Axes.indicate_inset* methods

c5c1b2a

See matplotlib#14275

1. Methods now return a tuple as documented, instead of a list.
2. indicate_inset() now does not error when optional inset_ax is not
passed, but returns None instead of a tuple.

clbarnes added a commit to clbarnes/matplotlib that referenced this issue


          FIX: Axes.indicate_inset* methods

86f5fb0

See matplotlib#14275

1. Methods now return a tuple as documented, instead of a list.
2. indicate_inset() now does not error when optional inset_ax is not
passed, but returns None instead of a tuple.

Member

timhoffm commented Jul 16, 2020

Closed by #14278.

timhoffm closed this as completed

QuLogic added this to the v3.2.0 milestone

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment