Mirror of forum.nim-lang.org

4373 :: What do I call this Part?

• rapidtransit440 (orginal) [2018-11-10T21:54:25+01:00] view original

  Inside some proc's there is this runnableExamples: what is this called? Is runnableExamples the only keyword for this type of code block, and is it always indented by four spaces? I'm trying to generate a parser for IntelliJ

  runnableExamples:
        let
          a = [2, 3, 1, 5, 4]
          b = sorted(a, system.cmp)
          c = sorted(a, system.cmp, Descending)
        doAssert b == @[1, 2, 3, 4, 5]
        doAssert c == @[5, 4, 3, 2, 1]
  Run

  More about the plugin: So far a lot of swearing, The PEG parser (I think it is? I don't know) makes no sense to me coming from ANTLR, I could practically copy and paste the grammer spec from the manual with ANTLR. Anyone have experience could give me a hand.

  I've built my own plugins before that have added special inspections, tool windows, auto complete etc.

---

• juancarlospaco (orginal) [2018-11-10T22:32:29+01:00] view original

  runnableExamples are runnable examples, named runnable examples and its the only name for it, they run with nim doc file.nim and generate self-documentation, they can be indented by 4 spaces, but best practice is indented by 2 spaces.

---

• rapidtransit440 (orginal) [2018-11-11T02:44:33+01:00] view original

  Ah I thought this was different than what I had read about, I thought the runnableExamples were contained in doc-blocks

---

• juancarlospaco (orginal) [2018-11-11T04:22:41+01:00] view original

  They can live outside too, I add them at the bottom of the main file for example, they get rendered on the Documentation as Examples of how to use the code, etc.

---

• Araq (orginal) [2018-11-11T10:44:20+01:00] view original

  From a parsing perspective runnableExamples is nothing special. Your parser needs to be able to handle

  mymacro:
    bodyOfCodeHere
  Run

---

• rapidtransit440 (orginal) [2018-11-11T13:23:27+01:00] view original

  @Araq you think it would be, I'm trying to wrap my ahead around how and why if only the first part of a rule matches it won't move to an alternative.

---