Skip to content

Update docstring format requirements to numpy style

Yakubov, Sergey requested to merge 5-switch-docstring-to-numpy into main

Summary of Changes

Set requirements to numpy and update an example. Actually, ruff does not enforce that and also accepts google style, at least partially. So we cannot be 100% sure that we can enforce the formatting.

Checklist

  • The MR has a clear and concise title
  • Code is self-documented and follows style guidelines.
  • Automated tests are written and pass successfully.
  • Regression tests (e.g. manually triggered system tests, manual GUI/tool tests, ...) are performed to make sure the MR does not break anything (when applicable)
  • Readme file is present and up-to-date.

Documentation Updates

Additional Notes

Closes #5 (closed)

Merge request reports