Update ref_dim in add_reference_lines

[rohanbabbar04]

• Pass ref_dim to references_to_dataset

With the references_to_dataset now updated in this PR, making the fix to support it here.

---

📚 Documentation preview 📚: https://arviz-plots--254.org.readthedocs.build/en/254/

[OriolAbril]

Given the goal is for this to eventually add text too if requested, I would update the default value for ref_dim in this function too to match the one in arviz-base. It also looks like I forgot to add it to the docstring

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 70.96%. Comparing base (62bdc22) to head (c06494d).
Report is 3 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #254      +/-   ##
==========================================
+ Coverage   69.30%   70.96%   +1.65%     
==========================================
  Files          41       42       +1     
  Lines        4721     4859     +138     
==========================================
+ Hits         3272     3448     +176     
+ Misses       1449     1411      -38     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[aloctavodia]

While here, what do you think about renaming add_reference_lines to add_lines?

[rohanbabbar04]

While here, what do you think about renaming add_reference_lines to add_lines?

I'm fine with that. We actually kept the word 'reference' in mind because we have ref_dim, and the function's initial purpose was to plot reference lines. However, ideally, it could also be used to plot other vlines/hlines.

[rohanbabbar04]

Should we merge this? We can rename add_reference_lines to add_lines (if we wish to change it) in another PR, since the tests will fail for other PRs until this goes in