Docs/new user guide - #816
Conversation
657946c to
0e4417d
Compare
863c1d3 to
cf4c3ce
Compare
91d6a0a to
4b6f519
Compare
| ================== | ||
|
|
||
| UltraPlot accepts a broad set of keyword spellings so existing Matplotlib and | ||
| older UltraPlot code continues to work. New users only need a small canonical |
There was a problem hiding this comment.
Does this mean older ProPlot code ?
There was a problem hiding this comment.
same/same in this case I can add the disclaimer.
| abcstyle='(a)', | ||
| abc_kw={'fontsize': 11}, | ||
| ) | ||
|
|
There was a problem hiding this comment.
This formatting style—with one parameter per line—may align with coding conventions, but for this particular example it makes the code excessively long and requires too much scrolling, which severely hurts readability. I strongly suggest that, for this example, multiple parameters be placed on the same line as long as the line width allows.
There was a problem hiding this comment.
We can't otherwise our black check will trip. Unless I remove that but I also personally have no issue with longer text.
| # right-hand panels receive approximately square plotting areas. | ||
| layout = [[1, 2], [1, 3]] | ||
|
|
||
| # 3. Create the figure |
There was a problem hiding this comment.
May have inadvertently deleted it -- will correct.
Co-authored-by: Koyo MUNECHIKA <51052381+munechika-koyo@users.noreply.github.com>
Co-authored-by: Koyo MUNECHIKA <51052381+munechika-koyo@users.noreply.github.com>
Co-authored-by: Koyo MUNECHIKA <51052381+munechika-koyo@users.noreply.github.com>
Co-authored-by: Koyo MUNECHIKA <51052381+munechika-koyo@users.noreply.github.com>
Co-authored-by: Koyo MUNECHIKA <51052381+munechika-koyo@users.noreply.github.com>
Co-authored-by: Koyo MUNECHIKA <51052381+munechika-koyo@users.noreply.github.com>
| axs[1].imshow(image, origin="lower", aspect="auto") | ||
| axs[1].colorbar(mesh, label="Intensity", loc="r") |
There was a problem hiding this comment.
| axs[1].imshow(image, origin="lower", aspect="auto") | |
| axs[1].colorbar(mesh, label="Intensity", loc="r") | |
| im = axs[1].imshow(image, origin="lower", aspect="auto") | |
| axs[1].colorbar(im, label="Intensity", loc="r") |
Sorry, the returned value is required for the colorbar.
3 participants
Taking a few steps to have a softer introduction for newcomers.