Skip to content

Documentation missing for Workspace DocumentContext/RelatedDocuments #355

@weltkante

Description

@weltkante

What is the point of "context" documents and the RelatedDocuments API? The source code has little to no comments in that part, public functions like SetDocumentContext etc. (which I'm supposed to implement in my Workspace) don't even have a summary comment.

As far as I understand it "related documents" allow to associate multiple DocumentIds with one SourceTextContainer (aka text buffer) and one of these DocumentIds can be marked as "context document" (also called "active document" in some places).

As far as I can tell all documents opened on the SourceTextContainer will subscribe to the change event and update themselves when the SourceTextContainer raises its change-event. Why would anyone need multiple distinct DocumentIds opened into the same text buffer, all being updated with the same text? What's the point of that functionality? Am I missing anything?

Metadata

Metadata

Assignees

No one assigned

    Labels

    Area-IDEConcept-APIThis issue involves adding, removing, clarification, or modification of an API.Documentationhelp wantedThe issue is "up for grabs" - add a comment if you are interested in working on it

    Type

    No type

    Projects

    Status

    Completed

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions