GithubHelp home page GithubHelp logo

update examples about prologue HOT 8 OPEN

planety avatar planety commented on May 19, 2024
update examples

from prologue.

Comments (8)

keshon avatar keshon commented on May 19, 2024 3

OK, noted, will take a look, thanks!

from prologue.

keshon avatar keshon commented on May 19, 2024

Is it better if I make a separate repo on my side for examples during developing so I wont have to bother with pull requests until I'm done?

from prologue.

keshon avatar keshon commented on May 19, 2024

that would mean that all examples will assume that prologue is installed globally

from prologue.

ringabout avatar ringabout commented on May 19, 2024

I think you counld use runableExamples for simple examples. runnableExamples will be checked.

from prologue.

ringabout avatar ringabout commented on May 19, 2024

You could create a seperate repo in planety organization and rely on global prologue installation.

from prologue.

keshon avatar keshon commented on May 19, 2024

What did you mean by runableExamples? I'm kinda missed it.
I suggest I create some repo on my side like prologue-examples and will gradually fill it with examples (I will do it at my free time). When I finish I can add them to my fork of prologue and will create a pull request to merge.

from prologue.

keshon avatar keshon commented on May 19, 2024

You could create a seperate repo in planety organization.

Ok great then!

from prologue.

ringabout avatar ringabout commented on May 19, 2024

You could ref to this document
https://nim-lang.github.io/Nim/docgen.html
Generally, you can write an example file with rst comments like

# example1.nim

## Using GET, POST, PUT, PATCH, DELETE and OPTIONS
## -----------------
runnableExamples:
  proc hello(ctx: Context) {.async.} = discard
  doAssert ................

## Parameters in path
## -----------------------
runnableExamples:
  proc hello(ctx: Context) {.async.} = discard
  doAssert ................

runnableExamples docs in https://nim-lang.org/docs/system.html#runnableExamples%2Cuntyped

from prologue.

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.