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

Log warning when sf or ch_names are ignored #207

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Conversation

remrama
Copy link
Collaborator

@remrama remrama commented Mar 8, 2025

This minor PR adds clarification surrounding a question in #156 about the ch_names parameter. I'm just implementing direct suggestions from there to provide clarity for the user:

  1. Add clarification in the docstrings
  2. Add a user warning when arguments are provided by user but ignored by YASA

Raising an AssertionError instead of a warning might make more sense, as assertion checks are used in the opposite case a few lines later (i.e., when data is specified and sf is not). But I didn't want to break anyone's existing code in case they passed sf through for logistical reasons or something. Happy to change if anyone prefers it as a raised error.

@remrama remrama added invalid 🚩 This doesn't seem right documentation 📜 Related to online documentation or tutorials labels Mar 8, 2025
@remrama remrama linked an issue Mar 8, 2025 that may be closed by this pull request
@codecov-commenter
Copy link

codecov-commenter commented Mar 8, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.44%. Comparing base (c18f1a6) to head (b628c3c).

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #207      +/-   ##
==========================================
+ Coverage   77.40%   77.44%   +0.03%     
==========================================
  Files          14       14              
  Lines        2678     2682       +4     
  Branches      324      326       +2     
==========================================
+ Hits         2073     2077       +4     
  Misses        568      568              
  Partials       37       37              

☔ 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.

@remrama remrama marked this pull request as draft March 8, 2025 15:30
@remrama remrama marked this pull request as ready for review March 8, 2025 15:53
@remrama remrama requested a review from raphaelvallat March 8, 2025 15:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📜 Related to online documentation or tutorials invalid 🚩 This doesn't seem right
Projects
None yet
Development

Successfully merging this pull request may close these issues.

plot_average plots all channels, not only indicated ones
2 participants