search

k98kurz / autodox

Tool for generating documentation automatically from code annotations, types, and docstrings.
Other
2 stars 0 forks source link

Bug: __init__ method skipped on type[Protocol] class when using -include_dunder #1

Closed k98kurz closed 2 weeks ago

k98kurz commented 2 weeks ago

Describe the bug

When generating documentation for sqloquent v0.4.0, I encountered a problem: the __init__ methods for several subclasses of Protocol were skipped.

To Reproduce

Steps to reproduce the behavior:

  1. Clone the sqloquent repo
  2. python -m venv venv
  3. source venv/bin/activate
  4. pip install autodox==0.1.16
  5. misc/doxit.sh

The doxit.sh script contains 5 invocations of the autodox CLI tool, 4 of which make use of -include_dunder but fail to include the __init__ methods for Protocol subclasses.

Expected behavior

The __init__ method should be documented when using the -include_dunder option.

Platform and Version (please complete the following information)

k98kurz commented 2 weeks ago

There was an issue with the virtual environment. Once I fixed it, the tool behaved normally. False alarm.

k98kurz commented 2 weeks ago

It has recurred with a fresh installation in a fresh venv with Python 3.10

k98kurz commented 2 weeks ago

Works properly in 3.11 venv. Just checked my own readme documentation and noticed I had already documented this unfixable issue. Oops.