Clean up warnings during API reference generation
Closed this issue · 0 comments
pelletier commented
When generating the API reference, mkdocstrings
/griffe
emit a fair few warnings:
WARNING - griffe: /Users/thomas/.venv/dispatch-sdk/lib/python3.12/site-packages/dispatch/client.py:29: Confusing indentation for continuation line 5 in docstring,
should be 4 * 2 = 8 spaces, not 6
WARNING - griffe: /Users/thomas/.venv/dispatch-sdk/lib/python3.12/site-packages/dispatch/client.py:32: Confusing indentation for continuation line 8 in docstring,
should be 4 * 2 = 8 spaces, not 6
WARNING - griffe: /Users/thomas/.venv/dispatch-sdk/lib/python3.12/site-packages/dispatch/client.py:33: Confusing indentation for continuation line 9 in docstring,
should be 4 * 2 = 8 spaces, not 6
WARNING - griffe: /Users/thomas/.venv/dispatch-sdk/lib/python3.12/site-packages/dispatch/proto.py:260: Confusing indentation for continuation line 10 in docstring,
should be 4 * 2 = 8 spaces, not 6
WARNING - griffe: /Users/thomas/.venv/dispatch-sdk/lib/python3.12/site-packages/dispatch/fastapi.py:66: Confusing indentation for continuation line 9 in docstring,
should be 4 * 2 = 8 spaces, not 6
WARNING - griffe: /Users/thomas/.venv/dispatch-sdk/lib/python3.12/site-packages/dispatch/fastapi.py:67: Confusing indentation for continuation line 10 in docstring,
should be 4 * 2 = 8 spaces, not 6
WARNING - griffe: /Users/thomas/.venv/dispatch-sdk/lib/python3.12/site-packages/dispatch/fastapi.py:70: Confusing indentation for continuation line 13 in docstring,
should be 4 * 2 = 8 spaces, not 6
WARNING - griffe: /Users/thomas/.venv/dispatch-sdk/lib/python3.12/site-packages/dispatch/fastapi.py:71: Confusing indentation for continuation line 14 in docstring,
should be 4 * 2 = 8 spaces, not 6
WARNING - griffe: /Users/thomas/.venv/dispatch-sdk/lib/python3.12/site-packages/dispatch/fastapi.py:72: Confusing indentation for continuation line 15 in docstring,
should be 4 * 2 = 8 spaces, not 6
WARNING - griffe: /Users/thomas/.venv/dispatch-sdk/lib/python3.12/site-packages/dispatch/fastapi.py:73: Confusing indentation for continuation line 16 in docstring,
should be 4 * 2 = 8 spaces, not 6
WARNING - griffe: /Users/thomas/.venv/dispatch-sdk/lib/python3.12/site-packages/dispatch/fastapi.py:74: Confusing indentation for continuation line 17 in docstring,
should be 4 * 2 = 8 spaces, not 6
WARNING - griffe: /Users/thomas/.venv/dispatch-sdk/lib/python3.12/site-packages/dispatch/fastapi.py:77: Confusing indentation for continuation line 20 in docstring,
should be 4 * 2 = 8 spaces, not 6
WARNING - griffe: /Users/thomas/.venv/dispatch-sdk/lib/python3.12/site-packages/dispatch/fastapi.py:80: Confusing indentation for continuation line 23 in docstring,
should be 4 * 2 = 8 spaces, not 6
WARNING - griffe: /Users/thomas/.venv/dispatch-sdk/lib/python3.12/site-packages/dispatch/fastapi.py:81: Confusing indentation for continuation line 24 in docstring,
should be 4 * 2 = 8 spaces, not 6
WARNING - griffe: /Users/thomas/.venv/dispatch-sdk/lib/python3.12/site-packages/dispatch/function.py:53: No type or annotation for parameter '*args'
WARNING - griffe: /Users/thomas/.venv/dispatch-sdk/lib/python3.12/site-packages/dispatch/function.py:54: No type or annotation for parameter '**kwargs'
WARNING - griffe: /Users/thomas/.venv/dispatch-sdk/lib/python3.12/site-packages/dispatch/function.py:94: Confusing indentation for continuation line 7 in docstring,
should be 4 * 2 = 8 spaces, not 6
WARNING - griffe: /Users/thomas/.venv/dispatch-sdk/lib/python3.12/site-packages/dispatch/function.py:92: No type or annotation for parameter '*args'
WARNING - griffe: /Users/thomas/.venv/dispatch-sdk/lib/python3.12/site-packages/dispatch/function.py:95: No type or annotation for parameter '**kwargs'
WARNING - griffe: /Users/thomas/.venv/dispatch-sdk/lib/python3.12/site-packages/dispatch/function.py:112: Confusing indentation for continuation line 6 in docstring,
should be 4 * 2 = 8 spaces, not 6
WARNING - griffe: /Users/thomas/.venv/dispatch-sdk/lib/python3.12/site-packages/dispatch/function.py:114: Confusing indentation for continuation line 8 in docstring,
should be 4 * 2 = 8 spaces, not 6
WARNING - griffe: /Users/thomas/.venv/dispatch-sdk/lib/python3.12/site-packages/dispatch/function.py:143: Confusing indentation for continuation line 6 in docstring,
should be 4 * 2 = 8 spaces, not 6
WARNING - griffe: /Users/thomas/.venv/dispatch-sdk/lib/python3.12/site-packages/dispatch/experimental/durable/function.py:49: No type or annotation for parameter
'fn'
WARNING - griffe: /Users/thomas/.venv/dispatch-sdk/lib/python3.12/site-packages/dispatch/experimental/multicolor/compile.py:87: No type or annotation for parameter
'decorator'
These should be either fixed or silenced.