Skip to content

Conversation

@m-fila
Copy link
Member

@m-fila m-fila commented Jul 4, 2025

This a follow-up to #161. Some of the examples in docstrings were missing the algorithm argument

@m-fila m-fila requested a review from graeme-a-stewart July 4, 2025 06:59
@m-fila m-fila added the documentation Improvements or additions to documentation label Jul 4, 2025
@codecov
Copy link

codecov bot commented Jul 4, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.04%. Comparing base (3d69b46) to head (724ecc6).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #175   +/-   ##
=======================================
  Coverage   77.04%   77.04%           
=======================================
  Files          20       20           
  Lines        1294     1294           
=======================================
  Hits          997      997           
  Misses        297      297           

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

@Moelf
Copy link
Member

Moelf commented Jul 4, 2025

should we make these doctests?

@m-fila
Copy link
Member Author

m-fila commented Jul 4, 2025

I'm not sure, these functions are for specific strategies, the main one that people use and read about was updated. I think removing these examples is also an option (there are no examples for the EE variant)

Copy link
Member

@graeme-a-stewart graeme-a-stewart left a comment

Choose a reason for hiding this comment

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

Thanks for spotting!

@graeme-a-stewart graeme-a-stewart merged commit 2463114 into JuliaHEP:main Jul 17, 2025
12 checks passed
@m-fila m-fila deleted the power_examples branch July 17, 2025 10:48
mattleblanc pushed a commit to mattleblanc/JetReconstruction.jl that referenced this pull request Aug 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants