Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docstrings of ess, autocorr and bpv plots #2185

Merged
merged 16 commits into from
Jan 5, 2023

Conversation

asael697
Copy link
Contributor

@asael697 asael697 commented Dec 21, 2022

Description

Checklist

  • Follows official PR format
  • Code style correct (follows pylint and black guidelines)
  • Changes are listed in changelog

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

arviz/plots/autocorrplot.py Outdated Show resolved Hide resolved
arviz/plots/autocorrplot.py Outdated Show resolved Hide resolved
arviz/plots/autocorrplot.py Outdated Show resolved Hide resolved
arviz/plots/bpvplot.py Outdated Show resolved Hide resolved
arviz/plots/bpvplot.py Outdated Show resolved Hide resolved
arviz/plots/bpvplot.py Outdated Show resolved Hide resolved
arviz/plots/bpvplot.py Outdated Show resolved Hide resolved
arviz/plots/bpvplot.py Outdated Show resolved Hide resolved
arviz/plots/essplot.py Outdated Show resolved Hide resolved
arviz/plots/essplot.py Outdated Show resolved Hide resolved
asael697 and others added 15 commits January 2, 2023 20:02
update  the ``textsize`` argument description of the `plot_ess` function
Update the `plot_autorr` function's description and update the description of some arguments.
Update the documentation of the `plot_bpv` function
Co-authored-by: Oriol Abril-Pla <oriol.abril.pla@gmail.com>
Co-authored-by: Oriol Abril-Pla <oriol.abril.pla@gmail.com>
Co-authored-by: Oriol Abril-Pla <oriol.abril.pla@gmail.com>
Co-authored-by: Oriol Abril-Pla <oriol.abril.pla@gmail.com>
Co-authored-by: Oriol Abril-Pla <oriol.abril.pla@gmail.com>
update `plot_autocor()` function
@codecov
Copy link

codecov bot commented Jan 2, 2023

Codecov Report

Merging #2185 (4d99af5) into main (a2bdfda) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #2185   +/-   ##
=======================================
  Coverage   89.92%   89.92%           
=======================================
  Files         119      119           
  Lines       12419    12419           
=======================================
  Hits        11168    11168           
  Misses       1251     1251           
Impacted Files Coverage Δ
arviz/plots/autocorrplot.py 100.00% <ø> (ø)
arviz/plots/bpvplot.py 82.14% <ø> (ø)
arviz/plots/essplot.py 100.00% <ø> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@OriolAbril OriolAbril changed the title Update plot_ess documentation Update docstrings of ess, autocorr and bpv plots Jan 5, 2023
@OriolAbril OriolAbril merged commit 0d07244 into arviz-devs:main Jan 5, 2023
@asael697 asael697 deleted the arviz_gsod_docs branch February 9, 2023 23:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants