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

#1020 Correction of doctring for plot.py for sample_kwargs #1060

Merged
merged 3 commits into from
Sep 23, 2024

Conversation

Ishaanjolly
Copy link
Contributor

@Ishaanjolly Ishaanjolly commented Sep 22, 2024

Just changed `plot_curves` to `plot_samples`

Description

Sample Kwargs now has plot_samples instead of plot_curve -
    curve : xr.DataArray
        Curve to plot
    non_grid_names : set[str]
        The names to exclude from the grid. HDI and samples both
        have defaults of hdi and chain, draw, respectively
    subplot_kwargs : dict, optional
        Addtional kwargs to while creating the fig and axes
    sample_kwargs : dict, optional
        Kwargs for the :func:`plot_sample` function
    hdi_kwargs : dict, optional
        Kwargs for the :func:`plot_hdi` function
    same_axes : bool
        If all of the plots are on the same axis
    colors : Iterable[str], optional
        Colors for the plots
    legend : bool, optional
        If to include a legend. Defaults to True if same_axes
    sel_to_string : Callable[[Selection], str], optional
        Function to convert selection to a string. Defaults to
        ", ".join(f"{key}={value}" for key, value in sel.items())

Related Issue

Checklist

Modules affected

  • MMM
  • CLV

Type of change

  • New feature / enhancement
  • Bug fix
  • Documentation
  • Maintenance
  • Other (please specify):

📚 Documentation preview 📚: https://pymc-marketing--1060.org.readthedocs.build/en/1060/

@Ishaanjolly Ishaanjolly changed the title Ishaan plot name correc #1020 Correction of doctring for plot.py for sample_kwargs Sep 22, 2024
Copy link

codecov bot commented Sep 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 37.51%. Comparing base (f70db33) to head (5c681b1).

❗ There is a different number of reports uploaded between BASE (f70db33) and HEAD (5c681b1). Click for more details.

HEAD has 2 uploads less than BASE
Flag BASE (f70db33) HEAD (5c681b1)
3 1
Additional details and impacted files
@@             Coverage Diff             @@
##             main    #1060       +/-   ##
===========================================
- Coverage   95.85%   37.51%   -58.34%     
===========================================
  Files          39       39               
  Lines        3934     3934               
===========================================
- Hits         3771     1476     -2295     
- Misses        163     2458     +2295     
Flag Coverage Δ
37.51% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@@ -570,7 +570,7 @@ def plot_curve(
subplot_kwargs : dict, optional
Addtional kwargs to while creating the fig and axes
sample_kwargs : dict, optional
Kwargs for the :func:`plot_curve` function
Kwargs for the :func:`plot_sample` function
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think is plot_samples right? (s at the end)?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay! just done this.

@juanitorduz juanitorduz added the docs Improvements or additions to documentation label Sep 23, 2024
@juanitorduz juanitorduz merged commit 1a1703c into pymc-labs:main Sep 23, 2024
11 checks passed
@juanitorduz
Copy link
Collaborator

Thanks @Ishaanjolly

jsnyde0 pushed a commit to jsnyde0/pymc-marketing that referenced this pull request Sep 24, 2024
…pymc-labs#1060)

* feat: test.txt added for commit check

* feat: replaced plot_curve with plot_samples within ./mmm/plot.py

* fix: plot_samples instead of plot_sample
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

plot_curve references wrong function in sample_kwargs description
2 participants