Giter Club home page Giter Club logo

Comments (3)

nomeata avatar nomeata commented on May 17, 2024

@kritzcreek , how does your work on from dfinity/motoko#1536 affect this?

from motoko-base.

nomeata avatar nomeata commented on May 17, 2024

Function definition (I'm not sure what the proper terminology for this is)

You probablay mean “Function declaration” – we want the function name and type in the docs, but not the actual function body (that would be the function definition).

from motoko-base.

nomeata avatar nomeata commented on May 17, 2024

Doesn't src/List.mo already follow that pattern? Note that the current tool automatically inserts section headings and the function’s type for each function (as seen in the output at https://sdk.dfinity.org/docs/base-libraries/list).

Ok, granted, no examples in that file yet, but you can just put them in the documentation comment before each function, using normal asciidoc syntax.

from motoko-base.

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.