sphinx-doc / sphinx-doc/sphinx

autodoc shows undecorated signature for decorated functions

Open
#7,650 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

extensions:autodoc type:bug
Dominant language
Python
Stars
8k
Forks
2.6k
PR merge metrics
No merged PRs in 30d

Description

Describe the bug
autodoc shows undecorated signature for decorated functions

To Reproduce

def wrapper(fn):
    @functools.wraps(fn)
    def func():
        return fn(1, 2, 3)

    return func


@wrapper
def foo(x, y, z):
    return x + y + z
.. automodule:: example
   :members:
   :undoc-members:

This is converted to foo(x, y, z).

Expected behavior
The function foo should be shown as foo(). That is what users see.

Your project
No

Screenshots
No

Environment info

  • OS: Mac
  • Python version: 3.8.2
  • Sphinx version: 3.1.0dev
  • Sphinx extensions: sphinx.ext.autodoc
  • Extra tools: No

Additional context
No

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the example with Sphinx 3.1.0dev and the sphinx.ext.autodoc automodule directive. Trace how autodoc determines the displayed signature for the decorated function, then verify that the generated documentation shows foo() rather than foo(x, y, z).

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.