Skip to content

Modules should inherit top-comments from hidden includes too #926

Closed
@lpw25

Description

@lpw25

#654 made it so that an include that is marked with (** @inline *) can import a top-comment into a module if it's the first item. I think it would be good to extend this to also work for includes of hidden modules. Such includes are already automatically expanded, and commonly occur when people use the _intf.ml pattern because the _intf module is not usually exposed by the library. I think this would save people from a lot of @inline annotation, or more realistically, improve a lot of documentation where people have neglected to do that.

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