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

Miscellaneous docstring fixes and updates #944

Merged
merged 10 commits into from
Sep 13, 2023
Merged

Miscellaneous docstring fixes and updates #944

merged 10 commits into from
Sep 13, 2023

Conversation

msimberg
Copy link
Collaborator

  • Adds some missing preconditions
  • Updates the bt_band_to_tridiag docstring to actually be a docstring (instead of regular comment)
  • Adds a docstring for the distributed bt_band_to_tridiag
  • Removes duplicate "the" from some docstrings

cf. #935 (comment)

@msimberg msimberg self-assigned this Jul 20, 2023
@msimberg msimberg added Category:Documentation Improvements or additions to documentation Priority:Low labels Jul 20, 2023
@msimberg msimberg mentioned this pull request Jul 20, 2023
Merged
albestro
albestro approved these changes Aug 16, 2023
View reviewed changes
Copy link
Collaborator

@albestro albestro left a comment

Choose a reason for hiding this comment

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

LGTM

@msimberg msimberg force-pushed the docstring-fixes branch 2 times, most recently from 8dfe770 to 828552e Compare September 8, 2023 07:35
@msimberg msimberg force-pushed the docstring-fixes branch 4 times, most recently from c5d3776 to 538b295 Compare September 8, 2023 07:47
@msimberg
Copy link
Collaborator Author

msimberg commented Sep 8, 2023

All right, I've now updated all the algorithms to talk about explicit matrix and block sizes.

@msimberg msimberg requested a review from RMeli September 8, 2023 07:51
@msimberg
Copy link
Collaborator Author

cscs-ci run

@rasolca rasolca merged commit e1694e8 into eth-cscs:master Sep 13, 2023
3 checks passed
github-actions bot pushed a commit that referenced this pull request Sep 13, 2023
@rasolca
Doc Miscellaneous docstring fixes and updates (#944)
935f3de
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rasolca rasolca rasolca approved these changes

@RMeli RMeli Awaiting requested review from RMeli

@albestro albestro Awaiting requested review from albestro

Assignees

@msimberg msimberg

Labels
Category:Documentation Improvements or additions to documentation Priority:Low
Projects
DLA-F Planning
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@msimberg @rasolca @albestro @RMeli