Make GridSpec.update docstring match behavior. #13105
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The sentence "If any kwarg is None, default to the current value, if
set, otherwise to rc." is clearly wrong given the lines just below,
which overwrite the current value unconditonally:
This can also be checked with e.g.
where the update reset left to the rc value.
Given that the behavior has been like that ever since gridspec was added
to matplotlib, it seems better to update the docstring.
@jklymak In the same module there's also
but here too the implementation clearly always drops the figure attributes; IOW it always returns a copy of
self
completely ignoringfigure
. Given that you last touched this with the constrainedlayout work I don't know what the best approach is, but perhaps we can just get rid of that method...PR Summary
PR Checklist