Skip to content

Expand docstrings of linear solvers #470

Open

Description

@yguclu

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

Activity

  1. changed the title [-]Clarify in docstring if left/right/two-sided preconditioner is used[/-] [+]Improve docstrings[/+] on Mar 11, 2025
  2. changed the title [-]Improve docstrings[/-] [+]Expand docstrings of linear solvers[/+] on Mar 11, 2025
  3. added theissue type on Mar 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions