Netflix
Validate all docstrings
The docstrings for functions may have drifted. Would be nice to read through all the function docstrings and make sure the arguments are correct and the descriptions are clear.
Hi @mcpeak,
This would be my first OSS contribution. Do you want to check the existing docstrings of functions and see whether their descriptions and arguments are correct and clear?
Hi @yash1th , awesome! Thanks for contributing. The point here is to make sure that for all functions we're listing the correct parameters in the docstring. So if a function takes three arguments all the arguments are listed (and described if not obvious) in the docstring. Thanks!
So I did a grep -lr "\"\"\"" --exclude-dir=venv-rk/ --exclude-dir=.git to find all files where this would be required:
""" Formatted Docstrings:
-
[ ] repokid/init.py
-
[ ] repokid/hooks/init.py
-
[ ] repokid/cli/repokid_cli.py
-
[ ] repokid/utils/dynamo.py
-
[ ] repokid/utils/roledata.py
