Git Product home page Git Product logo

Comments (2)

dadadel avatar dadadel commented on July 17, 2024

Hi @peterjc,
Thanks for reporting this issue. I'll try to considere this.
Concerning Example, Pyment doesn't know that keyword so it considered it as a parameter.

from pyment.

Sup3rGeo avatar Sup3rGeo commented on July 17, 2024

Maybe pyment could consider all the sections sphinx also does?

https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html

Docstring Sections
All of the following section headers are supported:

Args (alias of Parameters)
Arguments (alias of Parameters)
Attention
Attributes
Caution
Danger
Error
Example
Examples
Hint
Important
Keyword Args (alias of Keyword Arguments)
Keyword Arguments
Methods
Note
Notes
Other Parameters
Parameters
Return (alias of Returns)
Returns
Raises
References
See Also
Tip
Todo
Warning
Warnings (alias of Warning)
Warns
Yield (alias of Yields)
Yields

@dadadel how hard would be to implement this? Could you give some pointers where to change this in the code?

from pyment.

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.