Giter Club home page Giter Club logo

Comments (3)

danieljanes avatar danieljanes commented on May 10, 2024 1

Good question - we've never defined and documented the style we want to use for Flower, but you're right, we should pick one and declare it as the official style. It should be one that plays well with Sphinx to enable us to link to other parts of the codebase from the docstring itself. We've also started to use docformatter, so it would be good to pick a style that docformatter understands.

Perhaps it's best if we build a very small demo that showcases how a good docstrin in the format we pick looks like, how it can link to / mention other code fragments, and how docformatter itneracts with it. Would you like to take this topic @pedropgusmao ?

from flower.

pedropgusmao avatar pedropgusmao commented on May 10, 2024

Are we sticking to a specific docstring style? I found a few here that we could choose from. I particularly like the Numpydoc.

from flower.

danieljanes avatar danieljanes commented on May 10, 2024

Btw, I like the Numpydoc style as well. We sometimes have rather involved type signatures, so it helps to have a dedicated line for that. We should also pick a style that makes it clear which parameters are optional and what their default values are.

from flower.

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.