Skip to content

Add docstrings for random matrix ensembles #89

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

Merged
merged 4 commits into from
May 22, 2025

Conversation

apkille
Copy link
Contributor

@apkille apkille commented May 22, 2025

#86 First part of improving documentation for this library. The new docs build locally and examples in docstrings are now tested.

@apkille
Copy link
Contributor Author

apkille commented May 22, 2025

Pinging @dlfivefifty for review! :0)

Copy link

codecov bot commented May 22, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 39.80%. Comparing base (c76044d) to head (d2b3451).
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master      #89   +/-   ##
=======================================
  Coverage   39.80%   39.80%           
=======================================
  Files          12       12           
  Lines         819      819           
=======================================
  Hits          326      326           
  Misses        493      493           

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

@apkille
Copy link
Contributor Author

apkille commented May 22, 2025

Ah, random seeds change with version number and rng arguments aren't defined in any methods in this package, so I can't use StableRNGs yet. This is annoying...

@apkille
Copy link
Contributor Author

apkille commented May 22, 2025

OK should be good to go.


rand(W::Haar, n::Int, doCorrection::Int = 1)

The additional argument `doCorrection` specifies whether or not the piecewise correction
Copy link
Member

Choose a reason for hiding this comment

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

We should change the camel case here at some point (but as a separate PR)

@dlfivefifty dlfivefifty merged commit fc98f3b into JuliaMath:master May 22, 2025
8 checks passed
@apkille apkille deleted the docstring branch May 22, 2025 18:04
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