Tk Source Code

View Ticket
Login
Ticket UUID: f41f675cca8fa5d6813d1997ea4a428bd5d5dd26
Title: TIP #577 was merged without necessary updates in the man pages
Type: Bug Version: main
Submitter: fvogel Created on: 2023-03-19 08:21:17
Subsystem: 23. Option Parsing Assigned To: fvogel
Priority: 5 Medium Severity: Minor
Status: Closed Last Modified: 2023-07-15 18:39:16
Resolution: Fixed Closed By: fvogel
    Closed on: 2023-07-15 18:39:16
Description:

The implementation of TIP #577 in [95b2bdbd] added a new option type: TK_OPTION_INDEX

This new option type must be documented in [913a7f07|doc/SetOptions.3]:

- description of TK_OPTION_INDEX in the "TEMPLATES" section
- update of the "OBJOFFSET VS. INTERNALOFFSET" section (depending on how [85cea56c27] is finally fixed)

Besides: Existence of acceptable indices <M>+<N>, <M>-<N>, end-<N> is another occurrence of missing info in the man pages, e.g. for menu items.

User Comments: fvogel added on 2023-07-15 18:39:16:
Merged in trunk.

fvogel added on 2023-07-14 19:27:57:

Documentation now completed in [9745b962] and [f54250b6].

I plan to merge tomorrow. Objections? Please speak up now.


fvogel added on 2023-05-29 11:27:40:

In [b1ee1d4681] I have now documented acceptable indices <M>+<N>, <M>-<N>, end-<N> that TIP #577 made available. I hope I didn't miss some place in the documentation where this should be mentioned as well.

At this point I intentionally didn't update the documentation for -underline (in doc/options.n and doc/ttk_widget.n) because I'm still in the dark about what is the expected behavior. I'll wait for [85cea56c27] and [a9929f112a] to be fixed first (Jan, please, could you have a look?).

Regarding the "OBJOFFSET VS. INTERNALOFFSET" section in doc/SetOptions.3: I suggest, following my findings in [85cea56c27] on 2023-04-02, to simply mention as a note that the internalOffset machinery is not supported by ttk widgets. Agreed?


fvogel added on 2023-03-22 23:56:50:
Thanks, yes, this is already a valuable improvement in the documentation.

I think that, in addition, <M>+<N>, <M>-<N>, end-<N> indices should be documented in the man pages of the Tk commands that can use these kinds of indices.

jan.nijtmans added on 2023-03-22 20:25:04:

How about [97b2e9ba96fa2719|this]?

I'm still puzzled about the "OBJOFFSET VS. INTERNALOFFSET". It just should work the same everywhere .... nothing special should be needed for ttk