Hey!
I'm currently working on elm-doc-test 
https://github.com/stoeffel/elm-doc-test.
Elm-doc-test is a tool that turns doctests (like python's doctest) into 
elm-tests and you can then run them using elm-test.
There are some advantages with this approach, like nice assertion messages 
and compiler errors for broken doctests (see repo for examples).
Richard, Noah and I had a discussion about the syntax for writing doctests 
(in https://github.com/stoeffel/elm-doc-test/pull/10) and I opened an issue 
to continue the discussion 
(https://github.com/stoeffel/elm-doc-test/issues/12).

the current syntax is:
`    >>> ` for an assertion, `    ... ` if the assertion needs more than 
one line and the following lines indented with 4 spaces is the expectation.

```
{-|
    >>> indexOfLineWithEquals
    ...      <| Array.fromList
    ...      <| String.lines "a\nb\nc = d\nf = d\n"
    2

    >>> indexOfLineWithEquals
    ...      <| Array.fromList
    ...      <| String.lines ""
    0
-}
```

There are some alternatives in the issue using only one `>`. 
As I stated in that issue I would like to keep the current syntax, because 
it's more obvious that `>>>` is not part of the example and not elm code, 
where `>` could easily be confused for a `gt` sign.


I would love to hear what the community thinks about the syntax.


Thanks Stöffel

-- 
You received this message because you are subscribed to the Google Groups "Elm 
Discuss" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to elm-discuss+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

Reply via email to