Note the reference field is sorted.
Summary:
The reference field is sorted by span (first by starting position, then by
ending position). The implementation already guarantees this, this change just
adds a note so users can depend on that sorting.
Reviewers: fromberger, zarko
Subscribers: #core_team
@@ -210,7 +210,8 @@ message DecorationsReply {
repeated Override override = 1;
}
- // The reference edges located in the specified window.
+ // The reference edges located in the specified window. Sorted in the order
+ // of their position in the file (first by start offset, then by end offset).
repeated Reference reference = 4;
// If requested, a list of diagnostics applying to the requested file location.
