Coder Social home page Coder Social logo

Comments (3)

parafoxia avatar parafoxia commented on June 3, 2024 1

This is linked to parafoxia/analytix#61 (pawamoy responded to that as I was writing this!).

from griffe.

pawamoy avatar pawamoy commented on June 3, 2024

Nice timing haha!

So, for reference (stated in the linked issue):

  • recent changes to our Numpydoc parser made it so that prose after sections is not allowed anymore (this makes us more compliant with Numpydoc's official style-guide which does not explicitly allow that)
  • !!! and ??? blocks are Markdown markup, and therefore what we call prose, and that's why these cannot be parsed after known sections such as Parameters or Returns anymore
  • instead, users can take advantage of the new parser capabilities, generic admonitions:
!!! note
    Hello.

...becomes:

Note
----
Hello.
  • finally, note that it is still possible to use Markdown markup in all the other places it was also supported: in section item descriptions, as well as in the non-section body of the docstring:
Summary.

Body. Markup still allowed here:

!!! note
    Working.

Parameters
----------
param1
    Description of param1.

    !!! warning
        Warning about param1.

param2
    etc.

The new admonitions can use any title, and their kind is inferred from the title (basically slugified title):

  • Note
    ----
    Hello.
    

    gives title=Note, kind=note

  • See also
    --------
    Something.
    

    gives title=See also, kind=see-also

I realize there's no way to specify the kind and title separately. Maybe the logic could be improved here to support things like:

Warning: Pay attention to something
-----------------------------------
Contents.

...giving kind=warning, title=Pay attention to something. @machow what do you think?

from griffe.

pawamoy avatar pawamoy commented on June 3, 2024

I will close this issue but pin it for some time, in case others are impacted by the change.

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.