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

Feature/remove plot option #355

Merged
merged 4 commits into from
May 8, 2024
Merged

Feature/remove plot option #355

merged 4 commits into from
May 8, 2024

Conversation

blooop
Copy link
Collaborator

@blooop blooop commented May 8, 2024

No description provided.

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @blooop - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 2 issues found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

@@ -217,7 +217,7 @@ def sweep_sequential(
group_size: int = 1,
iterations: int = 1,
relationship_cb=None,
plot=None,
Copy link
Contributor

Choose a reason for hiding this comment

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

suggestion (code_clarification): Consider specifying default value for plot_callbacks more explicitly.

Using None as a default for a parameter expected to be a list or boolean can be ambiguous. Consider using an empty list or a specific boolean value as a default to enhance clarity and avoid potential NoneType errors.

Suggested change
plot=None,
plot_callbacks: List | bool = [],

@@ -270,7 +269,7 @@
you want the benchmark function to be passed the repeat number
tag (str,optional): Use tags to group different benchmarks together.
run_cfg: (BenchRunCfg, optional): A config for storing how the benchmarks and run
Copy link
Contributor

Choose a reason for hiding this comment

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

nitpick (typo): Correct the typo and clarify the type in the docstring.

The word 'clal' should be corrected to 'call'. Also, the type hint in the docstring should match the actual parameter type (List | bool) instead of (List | False).

Copy link

codecov bot commented May 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.28%. Comparing base (7f2b11c) to head (50c41a9).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #355      +/-   ##
==========================================
- Coverage   88.98%   88.28%   -0.71%     
==========================================
  Files          54       54              
  Lines        3140     3140              
==========================================
- Hits         2794     2772      -22     
- Misses        346      368      +22     

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

@blooop blooop merged commit fa6a61e into main May 8, 2024
5 of 6 checks passed
@blooop blooop deleted the feature/remove_plot_option branch May 8, 2024 13:06
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.

1 participant