Skip to content

Stop recommending ncol in legend examples #25110

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

Merged
merged 1 commit into from
Jan 30, 2023

Conversation

eerovaher
Copy link
Contributor

PR Summary

Since 958e329 the preferred keyword for controlling the number of columns in a legend is ncols. However,

$git grep ncol= a30c0b13386ca9469ffcfed5fa24fd21aaba49c5  # current main

reveals several uses of the old keyword. This pull request replaces most of them with the new recommended ncols, but three uses of ncol should remain in place:

PR Checklist

Documentation and Tests

  • Has pytest style unit tests (and pytest passes)
  • [N/A] Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • [N/A] New plotting related features are documented with examples.

Release Notes

  • [N/A] New features are marked with a .. versionadded:: directive in the docstring and documented in doc/users/next_whats_new/
  • [N/A] API changes are marked with a .. versionchanged:: directive in the docstring and documented in doc/api/next_api_changes/
  • [N/A] Release notes conform with instructions in next_whats_new/README.rst or next_api_changes/README.rst

Since 958e329 the preferred keyword for
controlling the number of columns in a legend is `ncols`, but some code
examples have still been using `ncol`.
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Thank you for opening your first PR into Matplotlib!

If you have not heard from us in a while, please feel free to ping @matplotlib/developers or anyone who has commented on the PR. Most of our reviewers are volunteers and sometimes things fall through the cracks.

You can also join us on gitter for real-time discussion.

For details on testing, writing docs, and our review process, please see the developer guide

We strive to be a welcoming and open project. Please follow our Code of Conduct.

Copy link
Member

@rcomer rcomer left a comment

Choose a reason for hiding this comment

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

Thanks @eerovaher! I think we just need to wait for the CI to pass…

Copy link
Member

@ksunden ksunden left a comment

Choose a reason for hiding this comment

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

rerunning tests which failed for seemingly unrelated reasons (macos subprocess timeout, though test_blit, not the most common test_interactive)

Anyone can merge on green CI

@ksunden ksunden added this to the v3.7.0 milestone Jan 30, 2023
@ksunden ksunden merged commit a38681c into matplotlib:main Jan 30, 2023
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Jan 30, 2023
jklymak added a commit that referenced this pull request Jan 31, 2023
…110-on-v3.7.x

Backport PR #25110 on branch v3.7.x (Stop recommending `ncol` in legend examples)
@eerovaher eerovaher deleted the recommend-ncols branch January 31, 2023 00:14
@rcomer
Copy link
Member

rcomer commented Jan 31, 2023

Thank you for submitting your first PR to Matplotlib @eerovaher. We hope to hear from you again.

@ksunden ksunden mentioned this pull request Feb 20, 2023
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

Successfully merging this pull request may close these issues.

3 participants