ml-tooling / lazydocs

📖 Generate markdown API documentation from Google-style Python docstring. The lazy alternative to Sphinx.
MIT License
205 stars 38 forks source link

Failed to generate docs for module device: ValueError('invalid method signature') #31

Closed EternityForest closed 2 years ago

EternityForest commented 2 years ago

Describe the bug:

Generating docs fails with no real indication of what the issue is.

Expected behaviour:

A reference to the specific bad method.

Steps to reproduce the issue:

The failure was on this repo: https://github.com/EternityForest/iot_devices/commit/8a63394550cb3bf4d1f7561a4e6c32031961d724

But I suspect the actual error itself is on my end and the issue is just with a lack of clarity in the error message.

github-actions[bot] commented 2 years ago

This issue is stale because it has been open 90 days with no activity. Remove stale label or comment or this will be closed in 14 days