tut icon indicating copy to clipboard operation
tut copied to clipboard

comments with 2.13

Open tpolecat opened this issue 5 years ago • 10 comments

In 2.13 comments evidently work differently so something like

```tut
// foo
1 + 1
```

Will report an error and then continue just fine, but it will fail the compile.

See Gitter discussion at :point_up: February 3, 2019 1:14 PM

tpolecat avatar Feb 03 '19 21:02 tpolecat

I worked around it (for now) by moving the comments into the function body.

larsrh avatar Feb 16 '19 17:02 larsrh

This is causing https://github.com/typelevel/spire/pull/759 to fail CI at the doc generation step

erikerlandson avatar Mar 05 '19 21:03 erikerlandson

For now I recommend only generating doc for 2.11 or 2.12

tpolecat avatar Mar 05 '19 21:03 tpolecat

:+1:

erikerlandson avatar Mar 05 '19 21:03 erikerlandson

I ended up doing this as a workaround: typelevel/cats-mtl@1e89758b505ad7f39b4421f15041bad201e53d27

larsrh avatar Mar 05 '19 21:03 larsrh

has anyone looked into whether the root cause might be a regression in Scala itself?

SethTisue avatar Mar 05 '19 22:03 SethTisue

I think migrating everyone to mdoc in time is infeasible. A thorough investigation would be highly appreciated.

larsrh avatar May 21 '19 07:05 larsrh

Pureconfig is waiting on a fix for this too, which I mention mostly so I'll get notified of updates. https://github.com/pureconfig/pureconfig/pull/537/files#diff-354f30a63fb0907d4ad57269548329e3R26

leifwickland avatar Aug 08 '19 23:08 leifwickland

This is as good a time as any to deprecate tut, so that's what I'm inclined to do. Mdoc is the way forward.

tpolecat avatar Aug 09 '19 14:08 tpolecat

@tpolecat Thanks for the heads up and for your years of work on tut.

leifwickland avatar Aug 09 '19 15:08 leifwickland