GithubHelp home page GithubHelp logo

Comments (5)

zerothi avatar zerothi commented on August 21, 2024 1

I think sphinx uses the func.__doc__ after import, to catch changes done automatically. Since the wrapped function uses functools.wrap it will retain the doc string.

from sisl.

zerothi avatar zerothi commented on August 21, 2024

Agreed, for now I have added a simple thing. It would be great if the decorator added this automatically. :)

from sisl.

pfebrer avatar pfebrer commented on August 21, 2024

The function that appears on the docs is the original one or the one returned by the decorator?

from sisl.

zerothi avatar zerothi commented on August 21, 2024

The function that appears on the docs is the original one or the one returned by the decorator?

The decorator does not change the docs currently, so it is the wrapped functions doc-string.

from sisl.

pfebrer avatar pfebrer commented on August 21, 2024

Yes, but I mean what sphinx catches is the wrapped function, not the raw text of the function definition?

from sisl.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.