GithubHelp home page GithubHelp logo

Comments (5)

pawamoy avatar pawamoy commented on May 30, 2024 2

Yes, there is, but it requires a complete refactor of pytkdocs, which I'm working on. Finding the right architecture and data structures will take some time 🙂

I'm currently thinking about the possibility of serializing objects from "unknown" categories (not a module, class, function, method, property or builtin value), and providing custom templates in mkdocstrings (and/or a way for users to provide their own templates) to render them nicely in the docs.

from pytkdocs.

camold avatar camold commented on May 30, 2024 1

Great to hear this feature is planned for version 0.11. Would be very useful to avoid redundancy in the docstrings (we currently have to state the default values in the docstring).
Just as a note, pydantic also allows for constraints, e.g. Field(1, ge=0, le=2) for the definition of an attribute with values between 0 and 2. These constraints do not seem to show up in __fields__ or __field_defaults__ though. So I guess there is no hope of having them included in the docs as well?

from pytkdocs.

pawamoy avatar pawamoy commented on May 30, 2024

When I added support for Attributes section, I forgot about Pydantic attributes, and told myself "attributes don't have defaults" 😅

from pytkdocs.

theoqian avatar theoqian commented on May 30, 2024

Same issue with attributes in class based on dataclass.

from pytkdocs.

pawamoy avatar pawamoy commented on May 30, 2024

This won't be implemented here (unless someone sends a PR), but rather in Griffe, as an extension. Feel free to open a feature request there (it's already in my backlog though, so I'll get to it eventually).

from pytkdocs.

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.