sphinx icon indicating copy to clipboard operation
sphinx copied to clipboard

Published 20 hours ago • verified publisher icon sphinx-doc

Fix #10605: autodoc unresolved type annotations

Open robsdedude opened this issue 1 year ago • 2 comments

Constructor annotations were not properly detected in autodoc when autodoc_typehints was 'description' or 'both'.

Feature or Bugfix

  • Bugfix

Relates

  • https://github.com/sphinx-doc/sphinx/issues/10605

robsdedude avatar Jul 29 '22 15:07 robsdedude

I think this PR might also fix https://github.com/sphinx-doc/sphinx/issues/8243 I should probably add a test to make sure.

EDIT: added the test and compared 5.1.x to this branch. It fixes it indeed.

robsdedude avatar Jul 30 '22 10:07 robsdedude

This PR is ready to be reviewed, if anyone fancies :)

Potentially pending: updating the docs with the new event. But I'd first like to get feedback if it's even worth putting further effort into this approach.

robsdedude avatar Aug 18 '22 12:08 robsdedude

@AA-Turner are you still interested in this fix? I'm happy to target another branch if you tell me which one. I'm a bit sad the time I invested just ended up as a stale PR.

robsdedude avatar Sep 27 '22 19:09 robsdedude

Dear Rob,

Thank you for alerting me to this, I wasn't aware that deleting the remote branch auto-closed PRs, and as it happens I had missed this PR.

Please may you re-target to 5.x?

Thanks, Adam

AA-Turner avatar Sep 27 '22 19:09 AA-Turner