Open tklib tickets: Docs

Triage of all 71 open and Pending tickets of tklib (bugs, patches and feature requests) on 2026-11-15: whether a bug still exists in tklib trunk with Tk 9.1 and 8.6, whether a patch is still needed, and whether a request has been implemented, superseded or become outdated. 25 prototype patches with regression tests; rows marked patch have one. None is committed.

Docs 6

⬜75429691a02024docs for module mapDOCS (still incomplete). The overview (map_overview.man) and 28 per-package man pages exist (4c7c6495fe, c15c0d5e4c, 2024-07-07). All per-pac…

Open ticket 75429691a0 · Documentation · Bug · filed 2024-07-06

Full verdict

DOCS (still incomplete). The overview (map_overview.man) and 28 per-package man pages exist (4c7c6495fe, c15c0d5e4c, 2024-07-07). All per-package pages are still stubs (27–44 lines, no [call] API entries).

  • Module map · Bug (Documentation)
  • Tested inspected modules/map/*.man in trunk.
  • Cause n/a
  • Prototype none (needs per-package API docs; not a small fix)
  • Suggested ticket action The overview and package descriptions are done. The per-package API reference is still missing, so keep the ticket open as a reminder, as aku intended.
⬜bb18815c6c2016Where is the "Diagram Language Tutorial"DOCS (still valid). modules/diagrams/include/introduction_ref.inc still says "Newcomers should read the [term {Diagram Language Tutorial}] first", …

Open ticket bb18815c6c · diagrams · Bug · filed 2016-05-03

Full verdict

DOCS (still valid). modules/diagrams/include/introduction_ref.inc still says "Newcomers should read the [term {Diagram Language Tutorial}] first", but no such document exists anywhere in tklib.

  • Module diagrams · Bug
  • Tested grep of modules/diagrams and apps/diagram-viewer*.
  • Prototype none (doc text only). Suggested change: replace the sentence with a pointer to the figures directory and apps/diagram-viewer, or write the tutorial.
  • Suggested ticket action The tutorial was never written. Until it is, the reference in diagram.man (include/introduction_ref.inc) should point to the example figures in modules/diagrams/figures instead.
⬜a6dd880cf22014Improve the documentation on the plotcumulative methodDOCS (still terse: plotchart.man only says "the data are accumulated to the previous values". Depends on fixing 50309a5936 first)

Open ticket a6dd880cf2 · plotchart · RFE · filed 2014-12-11

Full verdict

DOCS (still terse: plotchart.man only says "the data are accumulated to the previous values". Depends on fixing 50309a5936 first)

  • Module plotchart · RFE
  • Tested plotchart.man in trunk
  • Cause n/a
  • Prototype none (the semantics must be decided first)
  • Suggested ticket action Keep open together with 50309a5936. Once plotcumulative stacks on the previous bars (or is removed), document it with a small example.
⬜bf9e97fc3d2014No documentation for xyplotDOCS (still open: no xyplot.man. plotchart.man only has a demo program in the "Resizing" section)

Open ticket bf9e97fc3d · plotchart · RFE · filed 2014-11-23

Full verdict

DOCS (still open: no xyplot.man. plotchart.man only has a demo program in the "Resizing" section)

  • Module plotchart (xyplot) · RFE
  • Tested trunk modules/plotchart
  • Cause n/a
  • Prototype none. A man page should document xyplot path ?options? (-xformat, -yformat, -title, -xtext, -ytext, -background, -xticks, -yticks, -type), the methods add_data (-color, -legend), set_data, remove_data, rescale, cget/configure, and the zoom bindings (drag B1 to zoom, B3 to unzoom, scrollbars).
  • Suggested ticket action Still valid. xyplot only appears in a demo inside plotchart.man. A short xyplot.man listing the options and the add_data/set_data/remove_data methods is needed.
⬜1007764fff2004ctext - Clarifications needed in the documentationpatchDOCS. Points 1 and 2 confirmed (Tk 9.1, 8.6): adding a class does not rehighlight existing text until highlight is called; a second `addHighlight…

Open ticket 1007764fff · ctext · Bug · filed 2004-08-12

Full verdict

DOCS. Points 1 and 2 confirmed (Tk 9.1, 8.6): adding a class does not rehighlight existing text until highlight is called; a second addHighlightClassForRegexp with the same class name replaces the first pattern. Point 3 (linemap vs -elide) is not addressed.

  • Module ctext · Bug (Documentation)
  • Tested Tk 9.1, 8.6 script checking the tag ranges after each step.
  • Cause missing documentation in ctext.man.
  • Prototype 1007764fff.patch (+17 lines in ctext.man: when text gets highlighted, one pattern per regexp class, and (?i) embedded options with an example). Doc-only, so no test. Checked that doctools formats it without warnings.
  • Suggested ticket action Documented points 1 and 2 (and case-insensitive regexps, see 1007766fff). Point 3 (line numbers with elided text) remains open.
⬜1006144fff2004style module has no documentationDOCS (still no style.man (modules.tcl lists _man for it). The module still loads and style::use as|lobster works on Tk 9.1 and 8.6)

Open ticket 1006144fff · style · Bug · filed 2004-08-09

Full verdict

DOCS (still no style.man (modules.tcl lists _man for it). The module still loads and style::use as|lobster works on Tk 9.1 and 8.6)

  • Module style · Bug
  • Tested Tk 9.1 and 8.6, package require style, style::names, style::use for both styles
  • Cause n/a
  • Prototype none
  • Suggested ticket action Still undocumented. The module only tunes classic Tk widgets through the option database and has largely been superseded by ttk themes. Either add a short style.man (style::names, style::use, style::as enable/disable) or mark the module deprecated.