Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix #8105: Fix bug where autodoc generates incorrect signature for decorated class #8115

Closed
wants to merge 7 commits into from
Closed

Fix #8105: Fix bug where autodoc generates incorrect signature for decorated class #8115

wants to merge 7 commits into from

Conversation

harupy
Copy link
Contributor

@harupy harupy commented Aug 13, 2020 •
edited

Subject:

Feature or Bugfix

  • Bugfix

Purpose

@harupy harupy changed the title Fix bug where autodoc generates incorrect signature for decorated class Fix #8105: Fix bug where autodoc generates incorrect signature for decorated class Aug 13, 2020
@harupy harupy mentioned this pull request Aug 13, 2020
Closed
@harupy harupy marked this pull request as ready for review August 13, 2020 16:31
@harupy
Copy link
Contributor Author

harupy commented Aug 13, 2020

Test for a decorated __call failed:

https://github.com/sphinx-doc/sphinx/pull/8115/checks?check_run_id=981360925#step:5:1586

@harupy
Copy link
Contributor Author

harupy commented Aug 13, 2020

Looks like get_user_defined_function_or_method returns None here.

sphinx/sphinx/ext/autodoc/__init__.py

Line 1372 in 38b868c

call = get_user_defined_function_or_method(type(self.object), '__call__')

This was referenced Aug 13, 2020
Closed
Closed
@harupy harupy closed this Nov 2, 2020
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 22, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

autodoc uses a wrapper's signature for a decorated class
1 participant
@harupy