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] Update docstring and documentation for steadystate #240

Merged
merged 4 commits into from
Sep 28, 2024

Conversation

ytdHuang
Copy link
Member

Description

Summary of this PR:

  • add missing docstrings for steadystate and corresponding solvers.
  • update documentation for steadystate.

Copy link

codecov bot commented Sep 28, 2024

Codecov Report

Attention: Patch coverage is 95.83333% with 1 line in your changes missing coverage. Please review.

Project coverage is 93.51%. Comparing base (d634234) to head (d771643).
Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
src/steadystate.jl 95.83% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #240      +/-   ##
==========================================
- Coverage   94.39%   93.51%   -0.88%     
==========================================
  Files          31       31              
  Lines        2267     2268       +1     
==========================================
- Hits         2140     2121      -19     
- Misses        127      147      +20     
Flag Coverage Δ
?

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@ytdHuang ytdHuang changed the title Update docstring and documentation for steadystate [Docs] Update docstring and documentation for steadystate Sep 28, 2024
@albertomercurio albertomercurio merged commit bdac5f4 into qutip:main Sep 28, 2024
10 of 11 checks passed
@ytdHuang ytdHuang deleted the doc/steadystate branch September 28, 2024 10:02
albertomercurio pushed a commit to albertomercurio/QuantumToolbox.jl that referenced this pull request Sep 28, 2024
* add missing docstrings for `steadystate` solvers

* update documentation for `steadystate`

* format files

* improve `steadystate` documentation
albertomercurio pushed a commit to albertomercurio/QuantumToolbox.jl that referenced this pull request Sep 28, 2024
* add missing docstrings for `steadystate` solvers

* update documentation for `steadystate`

* format files

* improve `steadystate` documentation
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