Mirror of forum.nim-lang.org

7893 :: Assertions in the documentation.

• Javi (orginal) [2021-04-30T20:22:48+02:00] view original

  Hello,

  I'd like to make an assert that appends the conditions to the documentation comments.

  Something like:

  proc fn(x: float) =
      ## Bla, bla, bla.
      ##
      ## Preconditions:
      
      assertDoc x >= 0.0
      assertDoc x < 100.0
      ...
  Run

  Result:

  Bla, bla, bla.
  
  Preconditions:
      x >= 0.0
      x < 100.0
  Run

  Is possible to do this in Nim?

  Thank you.

---

• xigoi (orginal) [2021-05-01T04:18:40+02:00] view original

  Macros can't affect code outside of them, so you'll also have to add a custom pragma to the function. But other than that, it seems plausible.

---

• timothee (orginal) [2021-05-01T07:29:18+02:00] view original

  this would be entirely covered by https://github.com/nim-lang/RFCs/issues/270, both pre-conditions and post-conditions:

  proc sleep(t: int) {.requires t>=0.} = ...
  Run

  would render the pragma in the doc comment AND (when checks are enabled) would check the condition

---

• Javi (orginal) [2021-05-01T19:47:47+02:00] view original

  @xigoi

  Ah, good to know it, I'll try to do it.

  @timothee

  Great, that would be a nice solution.

  Thank you.

---

• ynfle (orginal) [2021-05-01T20:21:17+02:00] view original

  This specific example could be solved with range[0..99]

---

• DomoSokrat (orginal) [2021-05-01T22:55:36+02:00] view original

  The example uses a float, so ≤99 is not the same as <100.

---

• xigoi (orginal) [2021-05-01T23:11:15+02:00] view original

  Ranges don't work for float.

---

• ynfle (orginal) [2021-05-02T08:25:42+02:00] view original

  True

---

• SolitudeSF (orginal) [2021-05-02T08:34:13+02:00] view original

  they do https://nim-lang.org/docs/manual.html#types-subrange-types

---