doc: add description of **kwargs usage to collections #27872

ianhi · 2024-03-06T21:35:58Z

PR summary

Follow up to #27871 addressing the missing **kwargs in the Collection docstring

PR checklist

[NA] "closes #0000" is in the body of the PR description to link the related issue
[NA] new and changed code is tested
[NA] Plotting related features are demonstrated in an example
[NA] New Features and API Changes are noted with a directive and release note
[x?] Documentation complies with general and docstring guidelines

ianhi · 2024-03-06T21:37:09Z

The processing happens here:

matplotlib/lib/matplotlib/collections.py

Line 203 in 9e18a34

self._internal_update(kwargs)

which then calls:

matplotlib/lib/matplotlib/artist.py

Lines 1212 to 1218 in 9e18a34

    
               def _internal_update(self, kwargs): 
        
                   """ 
        
                   Update artist properties without prenormalizing them, but generating 
        
                   errors as if calling `set`. 
        
                   The lack of prenormalization is to maintain backcompatibility. 
        
                   """

lib/matplotlib/collections.py

Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>

* doc: add description of **kwargs usage to collections * Update lib/matplotlib/collections.py Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com> --------- Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>

pin pytest Deprecate plot_date Correctly set temporary pdf/pgf backends Calling `FigureCanvasPdf(figure)` will call `figure.set_canvas(self)`, meaning the `cbook._setattr_cm` context manager that wraps this change will see the _new_ canvas, and the old canvas isn't restored. Instead, just pass the `backend` parameter, as `savefig` already knows how to correctly save and restore the canvas if it needs to change backends. Fixes matplotlib#27865 Bump the actions group with 2 updates Bumps the actions group with 2 updates: [pypa/gh-action-pypi-publish](https://github.com/pypa/gh-action-pypi-publish) and [scientific-python/upload-nightly-action](https://github.com/scientific-python/upload-nightly-action). Updates `pypa/gh-action-pypi-publish` from 1.8.11 to 1.8.12 - [Release notes](https://github.com/pypa/gh-action-pypi-publish/releases) - [Commits](pypa/gh-action-pypi-publish@2f6f737...e53eb8b) Updates `scientific-python/upload-nightly-action` from 0.3.0 to 0.5.0 - [Release notes](https://github.com/scientific-python/upload-nightly-action/releases) - [Commits](scientific-python/upload-nightly-action@6e9304f...b67d7fc) --- updated-dependencies: - dependency-name: pypa/gh-action-pypi-publish dependency-type: direct:production update-type: version-update:semver-patch dependency-group: actions - dependency-name: scientific-python/upload-nightly-action dependency-type: direct:production update-type: version-update:semver-minor dependency-group: actions ... Signed-off-by: dependabot[bot] <support@github.com> Bump pydata-sphinx-theme to 0.15 Fix search button placement in navbar Fix doc sidebar Fix version switcher url for circleCI Don't use custom CSS for announcement banner Disable parallel build Don't show doc source link Add dtype/copy args to internal testing class Use pybind11 string formatter for exception messages This can eventually be replaced by `std::format` when we require C++20. doc: add description of **kwargs usage to collections (matplotlib#27872) * doc: add description of **kwargs usage to collections * Update lib/matplotlib/collections.py Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com> --------- Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com> TST: adding tests of current clear behavior on ticks closes matplotlib#23839 DOC: update comments and docstrings Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com> Update lib/matplotlib/tests/test_axes.py BLD,Cygwin: Included Python.h first in src/_c_internal_utils.cpp Python.h needs to be included before any system includes. This is easiest if it is the first include. Interestingly, pybind11/pybind11.h does not include Python, possibly depending on downstream projects including Python.h beforehand. CI: Include Python.h first in _tkagg.cpp Needs to be included before system headers to set visibility macros for pybind11 BLD: Include Python.h first in _backend_agg.cpp BLD: Include Python.h before pybind11/pybind11.h pybind11 assumes Python.h is included first. CI: Specify python version for default pytest. CI,Cygwin: Run pytest with python -m pytest Cygwin pytest recently updated, and only installs pytest-3.9 CI,Cygwin: Revert use of alternatives to set pytest script. Cygwin pytest only installs pytest-3.9. I should possibly suggest using alternatives for that and pip. CI,Cygwin: Avoid running pytest in root directory. CI,Cygwin: Revert running pytest in different directory. CI,Cygwin: Call pytest-3.9 explicitly. BLD: Include Python.h first in src/_path.h BLD,BUG: Remove Python.h includes immediately preceeding pybind11/pybind11.h includes pybind11 seems decent about including Python.h before any system headers, once you chase three layers of includes in to see that. FIX: handle nans in RGBA input with ScalarMappables DOC: Update some animation related topics - use `set_data_3d` - cross-reference `Line2d` `set_data`, `set_xdata`, `set_ydata` - Rewrite parts of the FuncAnimation description Inspired through matplotlib#27830. Revert "Merge branch 'matplotlib:main' into doc-change" This reverts commit feeabe6, reversing changes made to bcbc2ef. Reapply "Merge branch 'matplotlib:main' into doc-change" This reverts commit ed91cee. Convert path extension to pybind11 Add a pybind11 type caster for agg::rect_d Add a pybind11 type caster for agg::trans_affine Add a pybind11 type caster for mpl::PathIterator Add a pybind11 type caster for e_snap_mode Add a pybind11 type caster for SketchParams Optimize convert_polygon_vector a bit FIX: don't copy twice on RGB input Fix devdocs version switcher Allow passing a transformation to secondary_[xy]axis Add transform argument to secondary axes Update _secax_docstring Move new params to end of functions Add input check to secondary axes Add tests Add examples Move transform type checks and improve docs Add type stubs Update _secax_docstring Move new params to end of functions Add input check to secondary axes Move transform type checks and improve docs Fix rebase error Fix stub for SecondaryAxis.__init__ Clarify example Add default param to secax constructor Fix stub for secax constructor Simplify imports Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com> Remove redundancy in docs Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com> Fix typo DOC: fix stray release note entry BLD: Add a fallback URL for FreeType FreeType is available from both Savannah and SourceForge, and sometimes AppVeyor seems to have trouble downloading from Savannah, so perhaps this fallback will help. We used to try both these URLs in the pre-Meson build system. DOC: State approximate documentation build time Since the doc build takes very long, an order-of-magnitude estimate is helpful to manage expectations. I'm not wedded to the actual numbers, if somebody has better suggestions. A quick test on an old i7 6700 (from 2015) yielded - `O=-j1`: 23min - `O=-j4`: 15min Doc build on CI is around 18min. Add BackendRegistry singleton class Use backend_registry for name of singleton instance Use class variables for immutable collections Review comments Update lib/matplotlib/backend_bases.py Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com> Linting/mypy fixes Remove INTERACTIVE_NON_WEB backend filter Small changes from review Use _api.caching_module_getattr for deprecated module-level attributes Add docstrings Add api changes and what new docs Fix docs Inline the deprecation function calls Import BackendFilter and backend_registry into matplotlib.backends.__init__.py Mypy fixes Remove unused _safe_pyplot_import Remove unneeded type annotations Make sure custom alpha param does not change 'none' colors in a list of colors (matplotlib#27845) * fix issue 27839, make sure alpha param does not affect none colors Apply review feedbacks Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com> * Update lib/matplotlib/colors.py Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com> --------- Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com> Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com> DOC: fix :mpltype:`color` role `inline.interpreted()` already returns a list of nodes. We mustn't wrap it in another list. Use :mpltype:`color` for color types

doc: add description of **kwargs usage to collections

7be1b10

github-actions bot added the topic: collections and mappables label Mar 6, 2024

timhoffm reviewed Mar 7, 2024

View reviewed changes

lib/matplotlib/collections.py Outdated Show resolved Hide resolved

Update lib/matplotlib/collections.py

8bd9488

Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>

timhoffm approved these changes Mar 7, 2024

View reviewed changes

timhoffm added this to the v3.9.0 milestone Mar 7, 2024

timhoffm merged commit 0da2da0 into matplotlib:main Mar 7, 2024
38 of 39 checks passed

ianhi deleted the collect-docstring branch March 7, 2024 17:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: add description of **kwargs usage to collections #27872

doc: add description of **kwargs usage to collections #27872

ianhi commented Mar 6, 2024

ianhi commented Mar 6, 2024

doc: add description of **kwargs usage to collections #27872

doc: add description of **kwargs usage to collections #27872

Conversation

ianhi commented Mar 6, 2024

PR summary

PR checklist

ianhi commented Mar 6, 2024