Tk Source Code

View Ticket
Login
Ticket UUID: f42230ede8b97588fb0be895ca462bc8c1fd39c7
Title: Wrong description for WidgetViewSync in File doc/event.n from the latest check-in
Type: Support Version: latest check-in
Submitter: anonymous Created on: 2026-01-19 22:05:33
Subsystem: 69. Events Assigned To: nobody
Priority: 5 Medium Severity: Minor
Status: Open Last Modified: 2026-01-24 17:34:59
Resolution: None Closed By: nobody
    Closed on:
Description:
I'll use github links because they allow to highlight part of code 

https://github.com/tcltk/tk/blob/455293d6ef2e27f1aef50eddfbe20844c3aec653/doc/event.n#L443-L448

Says that 

> The `detail` field (%d substitution) is either true (when the widget is in sync) or false (when it is not).

But 

https://github.com/tcltk/tk/blob/455293d6ef2e27f1aef50eddfbe20844c3aec653/generic/tkTextDisp.c#L3140-L3169

calls 

https://github.com/tcltk/tk/blob/455293d6ef2e27f1aef50eddfbe20844c3aec653/generic/tkUtil.c#L1282-L1301

and sets `user_data` field, not `detail`.

Should not documentation should state that `user_data` is set instead of `detail`?
User Comments: emiliano added on 2026-01-24 17:34:59:

Fossil does support code highlight. Here's the equivalent of your first link:

https://core.tcl-lang.org/tk/file?ci=023f2ab0fba321bd&name=doc%2Fevent.n&ln=443-448

IMO the problem is not in the code, but in the event man page itself. While describing the EVENT FIELDS available to event generate, it reads

 -data string
      String may be any value; it specifies the  user_data  field  for
      the  event.   Only valid for virtual events.  Corresponds to the
      %d substitution for virtual events in binding scripts.

Since <<WidgetViewSync>> is a virtual event, the "%d" substitution corresponds to "user_data", not "detail", and should be changed accordingly.