René's URL Explorer Experiment

Title: REORG: JoinStyle and CapStyle classes by brunobeltran · Pull Request #18544 · matplotlib/matplotlib · GitHub

Open Graph Title: REORG: JoinStyle and CapStyle classes by brunobeltran · Pull Request #18544 · matplotlib/matplotlib

X Title: REORG: JoinStyle and CapStyle classes by brunobeltran · Pull Request #18544 · matplotlib/matplotlib

Description: Centralize docs and validation for JoinStyle and CapStyle in one place. On top of #18817 #19063. PR Summary First GSOD PR. Follow suggestion of @anntzer in MEP 30 to simply start making the simple string enum cases before moving onto more complicated things like LineStyle. The primary goal of this PR is to create a centralized place to document what is a JoinStyle anytime that parameter is used: class Collection(...): ... def __init__(...): """ ... joinstyle : `.JoinStyle`-like, default: :rc:`patch.joinstyle` Style to use for joining lines for all paths in the collection. """" This PR accomplishes this by adding (totally transparent) JoinStyle and CapStyle classes, which act as both a centralized location for documentation of these "features" of our library, and as validators (and, hopefully, in the future, serializers for rc). The user can still use the standard string input style, i.e. this still works: plt.plot(x, y, joinstyle='miter') Up until this point, I am basically just implementing the GSOD in the way which was agreed upon in the last dev call about this. But there are some additional considerations that come up once you start to implement this. As soon as any end-user-facing function takes a joinstyle argument, we have two options. Either we can immediately convert: def __init__(..., joinstyle=JoinStyle.round): ... # ValueError if invalid `joinstyle` self._joinstyle = JoinStyle(joinstyle) or we can validate the input but store the string: def __init__(..., joinstyle='round'): ... # ValueError if invalid `joinstyle` self._joinstyle = joinstyle if JoinStyle(joinstyle) The former has the upside of being in line with what we already do elsewhere in the library (e.g. MarkerStyle), while the latter has the upside of breaking less API surface naively (EDIT: although, as I point out to Tim in the comments below, this can be very strongly mitigated with enough care in implementing dunder methods for backcompat). This PR implements the approach where we immediately convert (the former of the two above). PR Checklist Has pytest style unit tests (and pytest passes). Is Flake 8 compliant (run flake8 on changed files to check). New features are documented, with examples if plot related. Documentation is sphinx and numpydoc compliant (the docs should build without error). Conforms to Matplotlib style conventions (install flake8-docstrings and pydocstyle<4 and run flake8 --docstring-convention=all). [N/A] New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there). [N/A] API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there). (Note: Tom explicitly does not want this new API surface advertised (yet)).

Open Graph Description: Centralize docs and validation for JoinStyle and CapStyle in one place. On top of #18817 #19063. PR Summary First GSOD PR. Follow suggestion of @anntzer in MEP 30 to simply start making the simple ...

X Description: Centralize docs and validation for JoinStyle and CapStyle in one place. On top of #18817 #19063. PR Summary First GSOD PR. Follow suggestion of @anntzer in MEP 30 to simply start making the simple ...

Opengraph URL: https://github.com/matplotlib/matplotlib/pull/18544

X: @github

direct link

Domain: github.com

Links:

Viewport: width=device-width