How to document types

[Timmmm]

One of the really nice things about XML schema is that you can add documentation for types. This is supported by IDEs and allows you to hover on elements to see help text about them. It's extremely useful. I think JSON Schema provides a similar feature (but I haven't used it and don't know how good IDE support it).

As far as I can tell there's no way to do that in Cue?

[verdverm]

There are plans for a language server to enable LSP support in IDEs. The docs are already attached to values in the AST, where appropriate. They work pretty similar to Go type documentation. I suspect there will be a CLI command too, like Go

[Timmmm]

How do you actually write documentation in a .cue file though? Or is it going to use heuristics to turn the // comments into documentation?

[slewiskelly]

Yes, you'd just write comments.

You can read more about Godoc here. The planned LSP, I believe, is going to be based on Dagger, which is here, and can see in action here.