| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
Sorry, something went wrong.
There was a problem hiding this comment.
The doc build still fails with
/home/circleci/project/doc/api/prev_api_changes/api_changes_1.4.x.rst:152: WARNING: py:obj reference target not found: tight_bbox.adjust_bbox /home/circleci/project/doc/api/prev_api_changes/api_changes_1.4.x.rst:152: WARNING: py:obj reference target not found: tight_bbox.process_figure_for_rasterizing /home/circleci/project/doc/api/prev_api_changes/api_changes_2.2.0.rst:162: WARNING: py:obj reference target not found: tight_layout.auto_adjust_subplotpars /home/circleci/project/doc/api/prev_api_changes/api_changes_3.0.1.rst:4: WARNING: py:obj reference target not found: tight_layout.auto_adjust_subplotpars /home/circleci/project/doc/api/prev_api_changes/api_changes_3.0.1.rst:4: WARNING: py:obj reference target not found: tight_layout.get_tight_layout_figure
These historic API change notes reference the now non-public API. The way to handle this is to change the links to verbatim as that API is no longer public and available in the docs. E.g. for the first one, change
`.tight_bbox.adjust_bbox`
to
``matplotlib.tight_bbox.adjust_bbox``
Sorry, something went wrong.
|
Thanks! I had that question in #22133, so I'll fix both. |
Sorry, something went wrong.
|
I did a specific comment in #22133 as well. |
Sorry, something went wrong.
|
Thanks @timhoffm ! I've updated both and will set them to be ready when the tests pass. I decided to not put links in the deprecation notices to not have to edit them when the modules actually are removed. |
Sorry, something went wrong.
There was a problem hiding this comment.
It just occured to me that we can an should keep the history for git blame. If you create a new _tight_bbox.py, copy everything over and add the stub in tight_bbox.py, then all of _tight_bbox.py will be marked as your change and not have any history behind that.
To preserve the history:
It's important that the move is in a separate commit. Otherwise git assumes you created _tight_bbox.py and modified tight_bbox.py. However, you can have the moves of both files in one commit and both deprecations in the second.
Sorry to bring this in at a quite late review stage, but it's really important for us to be able to easily dig into the code history.
Sorry, something went wrong.
|
Sure! Shouldn't be much work! (And clearly makes sense, although I didn't think about it before.) |
Sorry, something went wrong.
| Back | FazBrowse Home | New Git URL |
PR Summary
Related to #16181
The modules matplotlib.tight_bbox and matplotlib.tight_layout are deprecated.
Will add release notes once the tests pass (and I have a PR-number).
PR Checklist
Tests and Styling
Documentation