unison icon indicating copy to clipboard operation
unison copied to clipboard

allow doc literals in let blocks to omit empty bindings, as comments

Open aryairani opened this issue 7 months ago • 1 comments

Is your feature request related to a problem? Please describe. We don't have a syntax for comments within a definition (// comments are thrown away by the parser), but we sometimes use string constants instead.

foo = 
  Ability1.blarp
  _ = "Here comes the fancy bit."
  Ability2.bazbazbaz 6.54

Describe the solution you'd like

foo = 
  Ability1.blarp
  {{Here comes the fancy bit.}}
  Ability2.bazbazbaz 6.54

And then this Doc could also, optionally, be pretty-printed in the GUI or when a definition is displayed.

Describe alternatives you've considered Figure out some other first-class comments/internal documentation syntax, and/or choose something that will work to document a complex type or ability.

Additional context

aryairani avatar Mar 11 '25 16:03 aryairani