Git Product home page Git Product logo

Comments (1)

pawamoy avatar pawamoy commented on June 18, 2024

Hello @HugoMVale, thanks for the report 🙂

Some time ago we updated our Numpydoc-style docstring parser to improve its compliance with the official style guide, which does not explicitly allow prose in between or after known sections.

Admonitions like !!! info are prose (Markdown markup), and therefore are not supported anymore after known sections like Parameters, etc..

Instead, please use the style-specific support for admonitions:

def foo(x: float) -> float:
    """Foo function.

    Note
    ----
    This works.

    Parameters
    ----------
    x : float
        Number

    Returns
    -------
    float
        Square of number.

    Note
    ----
    This works too.

    """
    return x**2

Closing, but feel free to comment further!

from griffe.

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.