Commit 985f1acb authored by Robert Knight's avatar Robert Knight

Adjust comment for highlightsVisibleChanged

Remove the note about being able to toggle highlights from the host
frame, as the purpose of that note was unclear. Also add the context
that the event is only sent if the command to toggle highlights
originated from this guest.
parent bf1c1261
...@@ -19,8 +19,9 @@ export type GuestToHostEvent = ...@@ -19,8 +19,9 @@ export type GuestToHostEvent =
| 'anchorsChanged' | 'anchorsChanged'
/** /**
* Visibility of highlights was toggled from the guest frame (it can also be * Visibility of highlights was toggled from the guest frame. This event is
* toggled from the host frame). * not sent if highlights are turned on/off in the frame in response to a
* command from the sidebar or host frames.
*/ */
| 'highlightsVisibleChanged'; | 'highlightsVisibleChanged';
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment