8000 Remove the "Developing a new backend" section from contributing guide. by anntzer · Pull Request #14543 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]

Skip to content

Remove the "Developing a new backend" section from contributing guide. #14543

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
Jun 13, 2019

Conversation

anntzer
Copy link
Contributor
@anntzer anntzer commented Jun 13, 2019

That section basically duplicates the "what is a backend" section in the usage guide (https://matplotlib.org/devdocs/tutorials/introductory/usage.html#backends), but does so less well, and doesn't provide relevant information for actually developing a new backend.

PR Summary

PR Checklist

  • Has Pytest style unit tests
  • Code is Flake 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

That section basically duplicates the "what is a backend" section in
the usage guide, but does so less well, and doesn't provide relevant
information for actually *developing* a new backend.
Copy link
Member
@timhoffm timhoffm left a comment

Choose a reason for hiding this comment

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

I agree that this section should be removed here. Other than what I would expect from a section in Contributing -> Developing a new backend this does not tell anything about how to develop a backend. This just tells how to use a non-builtlin backend. Furthermore, I don't think there are many (any except @anntzer?) people developing new backends, so we don't need such a section.

That said, I still think that the usage guilde is not quite clear about the backend. I mixes "how to set a backend" with "how to set a non-builtin backend" in an ambiguous way. Will do a separate PR on this.

@WeatherGod
Copy link
Member
WeatherGod commented Jun 13, 2019 via email

@anntzer
Copy link
Contributor Author
anntzer commented Jun 13, 2019

I would guess both of these backends have probably existed for years, so don't really qualify as new...

@tacaswell tacaswell added this to the v3.2.0 milestone Jun 13, 2019
@tacaswell tacaswell merged commit 9d20afd into matplotlib:master Jun 13, 2019
@anntzer anntzer deleted the contributingbackend branch June 13, 2019 21:05
@timhoffm timhoffm mentioned this pull request Jun 13, 2019
6 tasks
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.

4 participants
0