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.

Sign up for GitHub

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

Jump to bottom

Expand docstrings of linear solvers #470

Open
3 tasks
yguclu opened this issue Mar 11, 2025 · 0 comments
Open
3 tasks

Expand docstrings of linear solvers #470

yguclu opened this issue Mar 11, 2025 · 0 comments
Labels
Next Release Must be in next release

Comments

@yguclu
Copy link
Member

yguclu commented Mar 11, 2025 •
edited
Loading

We should add the following information to the docstrings in psydac/linalg/solvers.py:

  • Clarify whether left/right/two-sided preconditioner is used
  • Give reference to original algorithm (book/paper/Wikipedia?), write it down in LaTeX, and show it in documentation
  • Clarify exit conditions (which residual, normalization, etc...)
@yguclu yguclu changed the title Clarify in docstring if left/right/two-sided preconditioner is used Improve docstrings Mar 11, 2025
@yguclu yguclu changed the title Improve docstrings Expand docstrings of linear solvers Mar 11, 2025
@yguclu yguclu added the Next Release Must be in next release label Mar 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Next Release Must be in next release
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@yguclu