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

[docs] improve various docstrings #3758

Merged
merged 10 commits into from
May 28, 2024
Merged

[docs] improve various docstrings #3758

merged 10 commits into from
May 28, 2024

Conversation

odow
Copy link
Member

@odow odow commented May 27, 2024

Copy link

codecov bot commented May 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.38%. Comparing base (fad385c) to head (15a74cc).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #3758   +/-   ##
=======================================
  Coverage   98.38%   98.38%           
=======================================
  Files          44       44           
  Lines        5869     5871    +2     
=======================================
+ Hits         5774     5776    +2     
  Misses         95       95           

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

@odow odow changed the title [docs] improve docstrings in src/optimizer_interface.jl [docs] improve various docstrings May 27, 2024
@odow
Copy link
Member Author

odow commented May 28, 2024

There are still a bunch that can be improved, but this is a good start.

@odow
Copy link
Member Author

odow commented May 28, 2024

The original motivation goes from
image
to
image

@odow odow merged commit ba34a49 into master May 28, 2024
11 checks passed
@odow odow deleted the od/opt-docstrinng branch May 28, 2024 21:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

1 participant