Progressively updated doc references (WIP)

[Srijha09]

Description

Resolves #1188. The external reference for backend_kwargs in plot_hdi has been added. Additionally, the see also section has been extended in compare with an addition of references. The work is still in progress for the other functions.

Checklist

• plot_hdi: nearly finished, only external references for backend_kwargs are missing.
• compare: extend see also section, maybe use references too? plot_separation is a good example on how to format references in docstrings

[OriolAbril]

Thanks for the PR!

[OriolAbril]

Suggested change

	These are kwargs specific to the backend being used, passed to :meth:`mpl:matplotlib.axes.Axes.plot` or
	:meth:`bokeh:bokeh.plotting.figure.Figure.patch`.
	These are kwargs specific to the backend being used, passed to
	:meth:`mpl:matplotlib.axes.Axes.plot` or
	:meth:`bokeh:bokeh.plotting.figure.Figure.patch`.

pylint is complaining the line is too long: https://dev.azure.com/ArviZ/ArviZ/_build/results?buildId=4420&view=logs&j=8a326fc5-acd0-5109-b239-57a83132e152&t=1e642e4d-ea03-518d-4dda-a3ee822acd3f&l=15

[Srijha09]

Thanks. I'll make the changes

[OriolAbril]

These are called comparison plots too but are actually not related to ours 😅. The reference should be https://doi.org/10.1007/s11222-016-9696-4. pylint is also complaining about the line length, I hope the doi link will be shorter, otherwise I don't really know how to fix that, I'd have to search and ask around.

[Srijha09]

Thanks for the review. My bad! Sorry for the confusion. I'll change the reference. Also just to clarify, the references must be linked to a journal?

[OriolAbril]

not necessarily, they can also link to books, websites, or even documentation or examples from other libraries. https://arviz-devs.github.io/arviz/api/generated/arviz.plot_loo_pit.html has one of each for example. They will often be papers though, because arviz aims to implement the latest algorithms which are generally not yet covered in books and are generally published as papers that describe them and show they work as intended.

[Srijha09]

Hey, I have updated the changes. I'm still getting a trailing whitespace error although I didn't have this issue in VSCode Editor with pylint enabled. Not sure how to fix this!

[OriolAbril]

This should do it. pylint indicates the problematic line. Trailing whitespaces are often ignored so unless the config used by pylint when run via vscode is exactly the same as arviz one it is not surprising to find extra errors and warning on ci

[codecov]

Codecov Report

Merging #1714 (1dbeac8) into main (4d9caca) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1714   +/-   ##
=======================================
  Coverage   90.86%   90.86%           
=======================================
  Files         108      108           
  Lines       11821    11821           
=======================================
  Hits        10741    10741           
  Misses       1080     1080           

Impacted Files	Coverage Δ
arviz/plots/hdiplot.py	92.45% <ø> (ø)
arviz/stats/stats.py	96.60% <ø> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4d9caca...1dbeac8. Read the comment docs.