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

Legend kwarg scatteroffsets vs. scatteryoffsets #1904

Closed
wants to merge 5 commits into from
Closed

Conversation

pelson
Copy link
Member

@pelson pelson commented May 22, 2013

In current HEAD of v1.2.x the docstring of Axes.legend and Figure.legend is not compatible with the kwargs accepted by legend.Legend (and also found in legend_handler).

axes/figure docstring: scatteroffsets
legend/legend_handler docstring/code: scatteryoffsets

I would have fixed it and opened a pull request but I am not sure which one is intended.

@mdboom
Copy link
Member

mdboom commented May 6, 2013

@leejjoon: As the legend guy, do you have any thoughts?

@leejjoon
Copy link
Contributor

As far as I can see, 'scatteryoffsets' has been used in the user code (use of 'scatteroffsets' should have raise an exception). And I believe the documentation of Axes.legend and Figure.legend is wrong (maybe me to be blamed). So, @megies : it would be really appreciated if you open an PR that fixes the documentation!

@pelson
Copy link
Member

pelson commented May 22, 2013

Fixed by #2047.

$> grep scatteroffsets * -r | grep -v build
lib/matplotlib/axes.py:          *scatteroffsets*: list of floats
lib/matplotlib/figure.py:          *scatteroffsets*: list of floats

@pelson pelson closed this May 22, 2013
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants