Add docstrings to FunctionSchema, update CONTRIBUTING.md with docstrings guidance, ignore __init__ docstrings if a class is sufficiently documented

This commit is contained in:
Mark Backman
2025-04-03 09:21:26 -04:00
parent e3bcb70b13
commit 3536cbcd13
3 changed files with 92 additions and 21 deletions

View File

@@ -115,6 +115,9 @@ select = [
"D", # Docstring rules
"I", # Import rules
]
# We ignore D107 because class docstrings already document __init__ parameters
# and our Sphinx configuration uses napoleon_include_init_with_doc=True
ignore = ["D107"]
[tool.ruff.lint.pydocstyle]
convention = "google"