ceylon-lang.org icon indicating copy to clipboard operation
ceylon-lang.org copied to clipboard

Document the `try` preprocessor commands and how to run the typechecker on the code samples.

Open FroMage opened this issue 12 years ago • 3 comments

@tombentley that one's for you and is important ;)

FroMage avatar Mar 18 '13 10:03 FroMage

I know nothing about the <!-- try --> annotations, I'm afraid. @quintesse or @chochos might know about them.

I will plead guilty for some of the others like <!-- cat --> though, which were used by the checker tool I wrote. I'm happy to document those, and the tool itself, if people are going to use the tool. Otherwise I see no point in keeping them there and I think we should get rid of them.

Where do you want this documentation?

tombentley avatar Mar 18 '13 10:03 tombentley

I know nothing about the <!-- try --> annotations

OK in that case @quintesse also needs to document this.

if people are going to use the tool

Looks like a useful thing to automate, no? I don't see why we shouldn't use that tool.

Where do you want this documentation?

Somewhere inside the project, perhaps README?

FroMage avatar Mar 18 '13 10:03 FroMage

I don't see why we shouldn't use that tool.

Fine, but then we need to put it in a repo somewhere, and keep it up to date. Currently it's at https://github.com/tombentley/cow and hasn't been run in a year.

tombentley avatar Mar 18 '13 10:03 tombentley