Update docs of GridSpec #15031
Update docs of GridSpec #15031
Conversation
| Parameters | ||
| ---------- | ||
| nrows, ncols : int | ||
| The number of rows and columns of the grid. | ||
|
|
||
| figure : `~.figure.Figure`, optional | ||
| Only used for constrained layout to create a proper layoutbox. |
There was a problem hiding this comment.
This is better than nothing, but still not too helpful.
@jklymak Maybe you have a better description?
| @@ -320,7 +321,12 @@ def __setstate__(self, state): | |||
|
|
|||
| def update(self, **kwargs): | |||
| """ | |||
| Update the current values. | |||
| Update the subplot parameters of the grid. | |||
There was a problem hiding this comment.
I'm more specific which values to update.
But, there's also some position updating of some Axes happening, which I don't understand, so I'm still not describing that.
The last sentence
Values set to None use the rcParams value.
seems to be more like "Values set to None revert the parameter to the default (see get_subplot_params)"?
Unfortunately this behavior is also different from SubplotParams.update.
|
|
||
| left, right, top, bottom : float, optional | ||
| Extent of the subplots as a fraction of figure width or height. | ||
| Left cannot be larger than right, and bottom cannot be larger than | ||
| top. | ||
| top. If not given, the values will be inferred from a figure or | ||
| rcParams when necessary. See also `GridSpec.get_subplot_params`. |
There was a problem hiding this comment.
i think the when necessary is extraneous
There was a problem hiding this comment.
What I wanted to express with that is that it is a delayed evaluation. In contrast to many other default fallbacks GridSpec.left stays None. The paradigm seems to be to use get_subplot_params which will resolve to the given alternatives.
Maybe "at usage time" or something would be better?
There was a problem hiding this comment.
at run time or at draw time or when the figure is being rendered? Those are both a bit more jargony than I like but maybe closer to clearer?
There was a problem hiding this comment.
Thanks. Chosen "at draw time" in #15106.
PR Summary
Some of the aspects of relation to figures with constrained layout and the
update()method are not quite clear to me. I've added docs for them as far as I could understand, but that could certainly be improved further. OTOH this is already an improvement as is and could be merged as such.