Skip to content

docs: standardize public API docstrings on NumPy style - #2675

Open
davidberenstein1957 wants to merge 2 commits into
mainfrom
docs/numpy-docstring-standard
Open

docs: standardize public API docstrings on NumPy style#2675
davidberenstein1957 wants to merge 2 commits into
mainfrom
docs/numpy-docstring-standard

Conversation

@davidberenstein1957

Copy link
Copy Markdown
Member

Summary

  • Document NumPy-style docstrings as the public API standard in CONTRIBUTING
  • Convert vulnerability_scan docstring to NumPy format as the exemplar

Closes #2668

Test plan

  • CONTRIBUTING renders correctly
  • make check PACKAGE=giskard-scan (docstring-only change)

Reformat README snippets so make check passes with ruff format on CI.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Development

Successfully merging this pull request may close these issues.

docs: standardize public API docstrings on NumPy style

1 participant