Improve backend documentation and get plot_forest to follow best practices #78
Conversation
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #78 +/- ##
==========================================
- Coverage 83.84% 83.58% -0.27%
==========================================
Files 20 20
Lines 2229 2181 -48
==========================================
- Hits 1869 1823 -46
+ Misses 360 358 -2 ☔ View full report in Codecov by Sentry. |
|
|
||
| Data | ||
|
|
||
| .. grid-item:: | ||
|
|
||
| .. raw:: html | ||
|
|
||
| <s>Viz</s> |
There was a problem hiding this comment.
nitpick, this will look better vertically centered and with a larger font size
There was a problem hiding this comment.
I think the best way forward would be to combine everything into an image. But didn't want to get into that to prematurely. I am still not sure about the backend name for example, if we keep this DataViz idea we could rename it to "data" instead of "none".
src/arviz_plots/plots/forestplot.py
Outdated
| The following examples focus on behaviour specific to ``plot_forest`` and aim to illustrate | ||
| usage of specific arguments. |
There was a problem hiding this comment.
| The following examples focus on behaviour specific to ``plot_forest`` and aim to illustrate | |
| usage of specific arguments. |
There was a problem hiding this comment.
I am not sure this intro is that useful so I suggest remove most of them and move the first sentence after the example and before the mini-gallery
There was a problem hiding this comment.
maybe we could get rid of that completely and link to plots_intro in a See Also section (which we should add at some point, similarly to the ones in current arviz)
src/arviz_plots/plots/forestplot.py
Outdated
| usage examples see :ref:`plots_intro`. Alternatively, to see common usage patterns | ||
| or how the plot looks for different combinations, links to all examples using | ||
| ``plot_forest`` in the example gallery are shown at the bottom of the docstring. |
There was a problem hiding this comment.
| usage examples see :ref:`plots_intro`. Alternatively, to see common usage patterns | |
| or how the plot looks for different combinations, links to all examples using | |
| ``plot_forest`` in the example gallery are shown at the bottom of the docstring. |
|
|
||
| Note that we are using the same :class:`~.PlotCollection`, so when using | ||
| ``map`` all the same aesthetic mappings used by ``plot_forest`` are used. | ||
| .. minigallery:: plot_forest |
There was a problem hiding this comment.
| .. minigallery:: plot_forest | |
| For a general introduction to batteries-included functions like this one and common | |
| usage examples see :ref:`plots_intro`. | |
| .. minigallery:: plot_forest |
There was a problem hiding this comment.
Left a comment above, but putting these two together might give users the idea they are related resources when they are completely different. One is quite general about functions inside arviz_plots.plots and covers the genral logic for plot_kwargs, aes_map, a bit on how to handle the returned object. Whereas the other are specific examples using the function.
IMO, people who are beginners and want to learn to use arviz-plots should go to the first resource, people who already have an idea on how to use it but are searching for a specific plot or want to see what do some of the arguments actually do should go to the 2nd
Co-authored-by: Osvaldo A Martin <[email protected]>
|
Let's try this and keep iterating. It would also be nice to get feedback on the automatic figsize (currently in use for plot_forest, plot_trace and plot_trace_dist) so we have to merge and see how it goes |
📚 Documentation preview 📚: https://arviz-plots--78.org.readthedocs.build/en/78/