Skip to content

Output for object types is completely unstructured #668

Closed
@impossiblynew

Description

@impossiblynew

The output for object types is completely unstructured. This is mostly fine for simple object types, but for larger ones it sometimes ends up looking worse than the format of the original interface!
For example:

type t = <
  method1 : string; (** does x *)
  method2 : int -> unit; (** does y *)
  method3 : string -> int list;
  method4 : int -> int -> int -> string;
  method5 : string -> string -> string;
  >

becomes
image

Furthermore, it is impossible to add documentation comments to the methods of an object type directly. This is really unfortunate for modules that hide their classes in their interface and instead expose the object type and functions for constructing the object, especially considering #525.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions